質の高い技術文書を書く方法 - As a Futurist...
大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は Amazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。 そもそも文書とは？ 英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料 会議の叩き台となる 1 枚ペラ 本番環境に変更を加えるにあたっての包括的な情報や具体
所感や私感を「ポエム」と呼ぶのをやめろ
詩を名乗る以上韻律や抒情を持ち、言葉は厳しく吟味されているべきではないか。 詩のこの厳しさと一般の文章を対比して、「散文的（まとまりがなくとっ散らかった）」という表現が生まれたくらいである。 Qiitaの「ポエム」タグは技術的な視座からでなく、詩的観点から批評を浴びせられるべきだと思う。 そして「ポエム」を名乗りつつも詩の体をなしていないものは即非公開にし、投稿者は出入り禁止に付すべきである。 かような厳しい批評を受ければ、「ポエム」を軽々しく名乗ることも減り、「所感」や「私感」と言った適当な表現に落ち着くのではないか。 現状のような倒錯が続けば技術コミュニティの疲弊が進むのみならず、詩を含む文芸全般への軽視の風潮さえ招きかねないと危惧する。
読まれるテキストは読者へのおもてなしの構造を持っている - mizchi's blog
大学生だった当時、梅田望夫の本を読んではてなにやってきた僕は、ブログ論壇への憧れだけがあって、技術者にもなれず、時流のテーマに対して書くべきテーマを持たず、ただ実家の宗教に対する恨みだけを書き綴っていた。 もちろん、そんなものを好きこのんで読む人はいなくて、ただ虚無へとテキストを放り込んでいたのだけだど、いつからか、ある程度パターンを獲得して、その真似をするようになって、成功失敗を繰り返して、それなりにPDCAを回してきたと思う。思えば、その過程でいろんな人のヘイトを買った気がする。 人間のテキストの読み方、その反応、というのはパターンを、いくつか書き起こしてみる。 読者は、ファーストビューのレイアウトで、読む読まないを決める タイトルは記事の印象の5割 章タイトルが残りの半分 本文はほとんど読み飛ばされる 書き手としては単語の印象の連なりでイメージを形成することになる 段落が均等に分割さ
「書く」を鍛える発想法「ノンストップ・ライティング」の魅力（アイデア大全より） - ぐるりみち。
5月に『アイデア大全』を読んで以来、同書に書かれている「発想法」をいくつか試している。『アイデア大全』については下記記事で感想をまとめているので、詳しくはそちらをどうぞ。 アイデアを生み出すための手法が、42個も掲載されている本書。当然、すぐに全部を実践できるはずもないので、暇なときにちょちょいと読み直しつつ試している格好。 そんな発想法のうち、継続的に取り組んでいる手法がひとつある。 『アイデア大全』を最初から最後まで読んだうえで、特に「これはぜひとも実践したい！」と感じられた手法。6月上旬から取り組むようになり、この2ヶ月以上、なんだかんだで続けられている。それどころか楽しんですらいるし、メリットと言えそうな効果も現れてきている。 それが、「ノンストップ・ライティング」だ。 スポンサーリンク テーマなし＆時間制限ありのフリースタイルが楽しい！ 「ノンストップ・ライティング」 あるいは「
ピラミッド原則を実践で学ぶ - 「考える技術・書く技術 ワークブック<上>」を読んだ - $shibayu36->blog;
前回「考える技術・書く技術」を読んで、書く・考える時に役立つピラミッド原則というものについてもう少し理解を深めたくなった。そこで、実践形式で書き込みながら学べる「考える技術・書く技術 ワークブック<上>」を読んだ。 考える技術・書く技術 ワークブック〈上〉 作者:バーバラ ミントダイヤモンド社Amazon この本は「考える技術・書く技術」での1章〜5章に書かれたルールを、実際の文章を使って適用していきながら学んでいく本だ。「考える技術・書く技術」を読むだけだと、ピラミッド原則の重要さは分かる一方で、じゃあどうやって使ったら良いかということはよくわからなかった。そのため、この本で実践すると知識が補完されて良い。 僕は「考える技術・書く技術」を読んでから、ワークブックに取り掛かった。しかし、実際には「考える技術・書く技術」を読みながらワークブックをやるというほうが効率も良く、おすすめだと思った
らいおんの隠れ家 : ポール・グレアム「文章術・簡易版」 - livedoor Blog（ブログ）
ポール・グレアムの「文章術・簡易版」(Writing, Briefly)を翻訳しました。原文はココです。 なお翻訳にあたり、practicalscheme様、kokezaru753様のコメントを反映させています。 http://q.hatena.ne.jp/1142919962 文章術・簡易版 2005年3月 (多くの人が、文章術に関するアドバイスを求めている。その1つに答えていたら、たまたまそのテーマに関する短いエッセイになってしまった。私はふつう、1つのエッセイに数週間をかける。このエッセイには67分かかった -- 執筆に23分、推敲に44分だ。私は実験として、このエッセイをオンラインにアップしよう。少なくとも内容はとても濃い) 私は、たいていの人が考えているよりも、上手に書くことはずっと重要だと思う。文章を書くことは考えを単に伝達するだけじゃない。考えを生み出すんだ。文章を書くのが下
読みやすい文章を書くための技法 - RyoAnna
『坊っちゃん』自筆原稿 読みやすい文章とは、流れるように読める文章だ。難しい言葉はいらない。気のきいた言葉もいらない。文頭から文末まで振り返ることなく読める文章が、最も美しい。 読みやすさの基準は客観的なものだ。読み手には様々な人がいる。老若男女すべての人に対して読みやすい文章を書くのは難しい。ただ、綺麗な文章を書こうとする意識は持ちたい。 文章を書く上で意識すべき技法を紹介する。 常体と敬体 常体とは「だ・である」調の文章であり、敬体とは「です・ます」調の文章を指す。それぞれにメリットとデメリットがある。 常体は、自分の意思を力強く伝える事ができるが、我の強い文章になる。敬体は、優しい印象で共感を得やすいが、まわりくどい文章になる。 常体と敬体を織り交ぜて書く手法もある。まずは自分で試してみて、書きやすい文体を見つければいい。 文章の始まりは短く 最初の一文は短いほうがいい。インパクトが
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
ishikawayulio.net
https://rentwi.textfile.org/?689724768577159169s
小論文の添削でしょっちゅう指摘したこと - らいおんの隠れ家