技術的な文章を書くための1歩、2歩、3歩 - Qiita

ちょっと書きたくなったので書くんじゃーい！ この文章を読み終わった時、読者がそれなりわかめ品質な文章を出力できるようになり、どこかに寄稿した時に全面リテイクを食らったりしないようになることを目指します。 mhidaka が 0歩目を書いてくれました！ 背景 筆者は普通のエンジニアです。その辺の開発とかしてる会社に勤めています。技術系の原稿も書きます。 原稿書きでご飯食べてるわけではありません(晩ご飯が豪華になることは稀にあります)。 今まで有能なレビューワー(muなんとかさんとか)編集さんとか(某社の安藤さんとか)とかとかに鍛えていただきました。 この場を借りてお礼を述べておきたいと思います。ありがとうございます。 なお、この文章は2013年10月時点での筆者(わかめ)のやり方です。 将来的にはより良いやり方を見つけるでしょうし、これとは全く違う書き方で上手にやっている人もいると思います。

[guldeen]

『誰がどう読んでも、ひとつの解釈にのみ受け取れる』文章を書くのは、じつはけっこう難しい事。そういう意味では、数学の数式証明問題などは、あれも立派な文章(一意にしか解釈できない)と言える。

[teppodone]

#てぽめも

[cuttoff19]

0歩目のやつも含めてとても良い記事だと思いました（文章力不足）

[o_ti]

技術的な文章を書くためのTIPS

[tacamy]

「読み終わった時に読者が得られるものを考える」わたしこれが抜けがちなのかも？

[hatajoe]

これは参考にしたい！

[mizchi]

読者、時系列で副作用があって難しい

[djfungsho]

良い。基本なのでメモ。

[decoy2004]

『筆者が留意しているのは、読者は有限オートマトン(有限状態機械)だということです。初期状態(対象読者を考える)と受理状態(読み終わった後に読者が得られるものを考える)は既に考えてあるはずです。』に同意。

[JHashimoto]

“この文章を読み終わった時、読者がそれなりわかめ品質な文章を出力できるようになり、どこかに寄稿した時に全面リテイクを食らったりしないようになることを目指します。”

[efcl]

技術書を書く方針について。 アウトライン、サンプルコード、実装

[uasi]

“編集履歴に作業風景がなるべく残るようにしてみました”→いい

[cotonohamohei]

from Pocket

[sakurasakuras]

設計 文章

[masaru_b_cl]

「理科系の作文技術」も併せて読むとよいと思います

[xoyip]

モンハンの例えにワロタｗ

[luccafort]

これだけの文章を3時間でっていうのは個人的には短いと思うんだけども一般的にどうなのかわからん。とりあえずクソを量産するか。でもTypeScriptは…

[Laylack]

これも後で見たい。

[criticabug]

「読者は有限オートマトン」同意。書いておきたいことはある…

[koogawa]

こういうのを待ってました！じっくり読ませて頂きます

[spacefrontier]

おお、これは分かりやすいな。/ トラブルが発生した時などのお客様向け説明用資料なんかも同じ構造。これ＋影響範囲、費用、時間の説明。

[cojicoji0228]

いつか読む

[yoshi-na]

長そうだから後で

[iori_o]

参考に