どうして開発者がドキュメントを書くべきか - 2011-10-27 - ククログ
オフィス文書形式が要求されるようなドキュメントではなくて、自分が開発したライブラリのドキュメント（リファレンスマニュアルやチュートリアルなどライブラリのユーザーが読むためのドキュメント）の話です。以下の「ドキュメント」もそのような意味で使っています。 使いやすいライブラリを開発したかったらプログラムだけではなくドキュメントも書くべきです。 なぜドキュメントを書くか ドキュメントを書く習慣があるかどうかは開発者によってあったりなかったりです。使っているプログラミング言語に相関がある気もしますし、リリースするかどうかに相関がある気もします。理由はいろいろあるでしょうが、ドキュメントを書く習慣のない開発者の方が多いでしょう。 書かない理由はこんな感じでしょうか。 面倒。 自分しか使わないからいらない。 どのように書けばよいかわからない。（どのツールを使えばよいかわからない。） 一方、書く理由はこ
「書くことの効果」実証される | WIRED VISION
前の記事 段ボール製、3000円の電子楽器シリーズ(動画) 「書くことの効果」実証される 2011年1月25日 サイエンス・テクノロジー コメント： トラックバック (0) フィードサイエンス・テクノロジー Brandon Keim Photo:Renato Ganoza, Flickr 学習し、記憶するには、それを題材にして文章を書くことが一番良い効果があるようだ。 1月21日付けで『Science』に掲載された研究では、大学生200人が科学に関する短い文章を5分間読むように求められた。 学生にはその後、次のいずれかの指示が与えられた。テスト向けの詰め込み勉強のように何度か読み返す、題材に関する「コンセプトマップ」[概念等の相関を表す地図]を作る、読んだ文章に関する自由形式のエッセー(小論文、作文)を10分間で書く、という指示だ。 1週間後、学生は覚えていることに関する簡単なテストを受け
卒業論文・修士論文を書く人へ
この文書は，初めて卒業論文・修士論文を書こうとする人に最低限守って欲しいと天野が思うような，論文のスタイルをまとめたものである．ただし，研 究室によっては，これとは異なる方針を持っておられるところもあると思うので，注意して欲しい． 「スタイルなんてどうでもいいじゃん」などとは，決して思わないで欲 しい． 多くの場合，体裁も整っていない論文は「きっと中身も出来が悪いに違いない」 という先入観を与えがちである．そして，私の経験からすると， その先入観はしばしば当たっている． もちろん，整っているからといってそれがいい論文であるとは言えないが，体裁 に問題があるようでは，すでに「読みやすさ」の点で論文の備えるべき資質を欠 いている． 英語で論文を書く場合の表現その他に関する注意は こちら． 日本語で論文を書く場合の表現その他に関する注意は こちら． 電気情報工学科・情報知能工学専攻ローカルな注
論文書きに役立つ記事のまとめ（逆引きインデクス）をつくってみた
Author:くるぶし（読書猿） twitter:@kurubushi_rm カテゴリ別記事一覧 新しい本が出ました。 読書猿『独学大全』ダイヤモンド社 2020/9/29書籍版刊行、電子書籍10/21配信。 ISBN-13 : 978-4478108536 2021/06/02 11刷決定 累計200,000部（紙＋電子） 2022/10/26 １４刷決定 累計260,000部（紙＋電子） 紀伊國屋じんぶん大賞2021 第３位 アンダー29.5人文書大賞2021 新刊部門 第１位 第２の著作です。 2017/11/20刊行、４刷まで来ました。 読書猿 (著) 『問題解決大全』 ISBN:978-4894517806 2017/12/18 電書出ました。 Kindle版・楽天Kobo版・iBooks版 韓国語版 『문제해결 대전』、繁体字版『線性VS環狀思考』も出ています。 こちらは１０刷
The Elements of Style Archives - Collection at Bartleby.com
Make definite assertions. Avoid tame, colorless, hesitating, non-committal language.—Rule 12 Asserting that one must first know the rules to break them, this classic reference book is a must-have for any student and conscientious writer. Intended for use in which the practice of composition is combined with the study of literature, it gives in brief space the principal requirements of plain Englis
NPG Nature Asia-Pacific : Nature Web Focus: 科学書の書き方
In this focus NatureのBooks & Arts欄のインタビュー・シリーズで、著名な科学書執筆者5人が、新進ライターに向けてアドバイスをしている。Peter Atkinsは、よく売れる教科書を1冊書くには相当な努力がいることを明かしている。Carl Zimmerは、一般向けの科学書を書くには情熱がいかに不可欠であるかを強調し、David Brinは批評が自身の書く小説をどのように向上させるかを語っている。また、Georgina Ferryは伝記を書くための調査のコツを披露し、Joanna Coleは子どもたちへの科学の伝え方について解説している。 Books & Arts Q&A: Peter Atkins on writing textbooks The success of Peter Atkins's classic textbook Physical Chemis
面白い論文の書き方（その一） - 社会学者の研究メモ
今回も教科書ネタ。 学生の論文には、読んでいて面白いものと、苦痛なもの指導しがいのあるものがあります。後者のような論文を書く学生は、論文についてこう考えていることが多いです。 興味のあることを見つけて、それについて文献を読み、それをまとめて、最後に自分の意見を書く。 こういう指導をされている先生方は意外に多いのではないかと思います（自分も昔はそうでした）。指導がラクだし。しかしこれは論文を書くときの方針にはなりませんし、してはダメです。 論文とは「研究成果」のアウトプットの1つです。少なくとも社会学における研究とは、解かれていない謎や決着のついていない問いを自分で見つけ出し、データ等の証拠を使ってそれに答えることです。（それ以外の論文もありますが、まず基本を抑えないとダメです。）上記のダメ方針は、研究と単なる勉強を取り違えているのです。 研究の手順は標準的に教えられているもので十分です。
学術論文の書き方のメモ - forest book
7年前の、当時、修士1回生のときに受講していた「科学技術表現」という講義のメモが出てきたので(自分用に)整理してみました。メモ書きなので講義を受講していない人には分かり難いかもしれません(^ ^;; 学術論文は、技術文書とは違い、内容の良し悪しに加えて、それが論文としての「体」をなしているかが重要です。数年前のお話なので、もしかしたら、現在はその「体」が少し変わっているかもしれません。ご参考まで。 早く安く作った論文やアルゴリズムはまったく独自の自分の考えしか残らない 論文の流れ タイトル 概要(アブストラクト) 序論(はじめに) 一番難しいので最後に書く 関連研究、問題意識、研究目的 本論部 アイディアの提示 実験 本論部と実験は、ちゃんと出来ていれば易しい 結論 繰り返しでも良いのでやったことを書く まとめと再アピール 長めに書く 論文のタイトル タイトルの使われ方 目次をざっと見て、
考えるための「文章力」
研究計画書をどう書くか 大学院進学を考える人が「文章力」といってまず思い浮かべるのが研究計画書でしょう。そこで，研究計画書を書くうえでの基本的な心構え，考え方について概観しておくことにしましょう。 研究題目の設定 研究題目とは，単に研究に名前をつけることではありません。かなり漠然とした題目を研究計画書などに書いているケースがあるようですが，これではいけません。題目設定にあたっては，研究対象と方法論の，少なくとも２つをしっかりとおさえておく必要があります。１つの典型例としては「○○の××的研究」というのを頭に置いておくとよいでしょう。もちろん，このとおりになる必要はありませんし，研究科や専攻によっても事情が違いますが，このような題目のとらえ方をしておくことが大切です。 具体的に題目を設定する前に，自分の研究分野の学術論文のタイトルに目を通しておくとよいでしょう（当然のことながら，丸写しは困り
なぜ増田小説概論
（ブックマーク数がとんでもないことになったため、元増田はうかれている。なので匿名ダイアリーなのに、ペンネームまで書いてしまった。タイトルに大きく、須江岳史、と。しかし、プロの小説家でもない一人のプータロウが書いた文章がこんなにもてはやされることを、すこし疑問にも思っている。ちょっと足を伸ばして図書館に行けば、小説の書き方についての本はいくらでも手に入るはずだ。何かを学び取る目的ではなく、長すぎるからブックマークしておいた、というのなら、納得する。 というかこの論は物語と小説をニアリーイコール扱いしていて、小説論としてはちょっと古いというか、語りという小説の大問題がスルーされていて厳しい。http://d.hatena.ne.jp/CloseToTheWall/20090703/p1 という指摘も当然のことで、普段、一人称の小説ばかり書いている自分には、人称とか視点とかいった物語を語る上での
なんでお金になることをタダで書くの？ - ぼくはまちちゃん！
ってことを知人に言われちゃいました…！ …こんにちはこんにちは！！ 「ね、ブログ書く人ってなんでお金になることをタダで書くの？」 ははは。 「その知識、セミナーとかにすれば儲かるのに…」 なるほど、そうかもしれない…。 なんでだろう、ぼくにとっては、べつにお金儲けが一番じゃない…からかな。 （ちょっとは広告を貼ったりもしてるけどね） けっして、世のため人のためなんていう崇高な理由じゃないよ。 たぶん、どちらかっていうと自分のため…。 あ、 他にも理由があった。 それは… 「知識そのものが単純にお金に変わるわけじゃない」っていうのも、あるかな。 うーん。 たとえば仮に、ぼくがセキュリティの知識のスゴイ人だったとして… いまここで「はまちやくんのセキュリティセミナー」なんてのを開催したとしましょうか…！ あるいは「SEOセミナー」なんてのでもいいね。 どうだろう。 人、来てくれるかな。 うん。
冗長な英文を避けるための10+の方法--上級者編
文：Calvin Sun（Special to TechRepublic） 翻訳校正：村上雅章・野崎裕子 2009-02-24 08:00 文章を簡素化することで、伝えたい内容をより明確かつ説得力のあるものにすることができる。本記事では、回りくどい表現を避けることで、文章をすっきりとさせ、読み手により強く訴えかけられるようにする方法を、実例を交えて紹介する。 あなたの書く文章は冗長なものとなってはいないだろうか？もしそうであれば、あなたは自らの時間と、読み手の時間を無駄にしてしまっていることになる。また、自らの文章を説得力に欠けた、印象の薄いものにしてしまっていることにもなる。以下に、冗長な文章と、その改善例を挙げているので、参考にしてほしい。 ＃1："There are/is ［名詞］［関係代名詞］［動詞］ …" "There are/is"と［関係代名詞］を取り去ると、この文章は、［名
ライフサイエンス英語
even ifとeven thoughをあたかも同じ意味であるかのように書いてある参考書をいくつか見かけたのでこの違いについて検討してみた。 まず、even thoughはalthoughと同じ意味である。日系２世カナダ人のYukoさんがやっているeChat Vancouver（第78回）というPodcastでも、「although, though, even thoughの意味は同じである」とハッキリ述べられていた。 同じであれば何の問題もないが、even thoughと似ているeven ifの意味は明らかに異なっている。 さて、以下の違いが分かるだろうか？ Even if it is raining tomorrow, I will go boating on the lake. （たとえ明日雨であったとしても、～） Even though it is raining today, I
レポートコピペ問題の問題 - ohnosakiko’s blog
小中学生の読書感想文に、ネットのサイト「〜児童、そして生徒のための〜自由に使える読書感想文」からのコピペが増えており、中には市の読書感想文コンクールで上位に入ってしまったものまであって、先生たちが頭を抱えている‥‥というニュースを昨日やっていた。 このサイトは2004年からあるもので、学校提出に限り著作権フリー（パクリ、コピペOK）としており、パクリがバレた時の反省文の書き方にまでリンクが張られているという親切設計。去年の夏休みにはアクセスが65万件とかで話題になっていたので、ニュースで取り上げられるのも初めてではないだろう。 読書感想文を書くのが苦手な子は少なくないらしい。国語の時間に、書いたものを何度か添削してもらうという経緯があればまだしも、いきなり夏休みの宿題で出たら困る子は多いかもしれない。「自由に使える読書感想文」はそういう小中学生の悩みに応えるもの。これは使っちゃうわなぁと思
ひとつ上のヒューマンマネジメント 10年後も通用する文章術(1) 「駄目でない」文章を書くための9カ条
私は企業のIT企画部門の課長としてチームメンバーの文章をチェックしています。また，教育コンサルタントとしてビジネス文章を教えたり，国家試験科目の論文添削をしています。 異なる立場で非常に多くの文章を見てきたので，今では「どんな文章が駄目なのか」がよく分かるようになりました。ここから紹介するのは「よい文章を書く技術」です。 「よい文章」とは「駄目でない文章」 私は人に「よい文章を書くコツは何ですか？」とよく聞かれます。そのときにはいつも，「駄目な文章を書かないようにすることです」と答えています。 人が何をもって「よい文章だ」と感じるかどうかは，極めて主観的なものだと考えています。個人の受け止め方や感じ方に依存する部分が多いからです。 では，ビジネス文書でも「よい文章」を書かなくてはいけないのでしょうか。もちろん，それができるに越したことはありません。 しかし，どんな人でも「うまい」と言わせる
なぜ「勉強はできたのに仕事はさっぱりな人」がいるのか？：IT＆ウェブ業界の転職をサポートする「CAREERzine」（キャリアジン）
メディア部門では、インターネットで加速するメディア環境の中で、翔泳社が得意とするテーマを深掘りしながら様々なドメインで最適化されたメディアビジネスを展開しています。
論文の書き方：結果から結論をどのように導くか？ - Y日記
※図が表示されない場合には→http://seibutsu.biology.kyushu-u.ac.jp/~yahara/logictree.JPG 論文では通常、複数の結果を記述する。しかし、主要な結論はひとつでなければならない。なぜなら、論文を書く目的は、何らかの主題（テーマ）に答えることであり、そして論文のテーマはひとつだからである。 「ひとつの論文にはひとつのテーマとひとつの結論」・・・これは論文を書くうえでの重要な原則である。この原則を守っていない論文が多いのも事実だが、それらは論理的に練られた論文とはいえない。 では、複数の結果からひとつの結論を導くにはどうすれば良いだろうか。4月以来、預かった原稿を改訂しながら、この問題を徹底して考えてみた。これまでは、自分の経験にもとづいて、いわば一種の職人芸によって、結論を導いていた。しかし、結果から結論を導くという作業は、論理的なプロセ
ブログ記事を大量に書き続ける７つの方法 | Lifehacking.jp
Zen Habits の Leo の記事の量と質とにはいつも驚かされています。私もわりと長文を書く方ですが、このサイトでは同様に長い記事がいつも１日に２つ、ないしは３つ書かれていて、しかも非常に大事な「大きな問題」を勇敢にタックルする傾向があります。 この仕事量の秘密はなんだろうかといつも思っていたところ、Leo がゲストとして書いている記事が Freelance Switch で紹介されていました。 ブログの記事を大量に書き続けるためにしている７つの約束事だそうです。太字は記事からの引用で、その後は私の要約です。 朝一番に書く： ８人家族を抱えている Leo は誰よりも早く、午前 4:30 に起きてメールも RSS も読む前にまず ToDo リストから書こうと思っていたことを書いてしまうそうです。 全ての雑事をシャットアウトする： メール、RSS はもちろん、Twitter や、意味もな
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
left over junk
裁判員制度で大わらわ 新聞各社が「自主規制」を開始
