読者です 読者をやめる 読者になる 読者になる

良いドキュメント

どうすれば良いドキュメントが書けるのか?
常日頃考えてます。

良いドキュメントの条件

  1. 興味を掻き立てられること
  2. おもしろいこと
  3. わかりやすいこと

これらがわかりやすいドキュメントの条件だと思っています。
ただしこれを全て満たすドキュメントを書くのは相当な力量が要るでしょう。
自分が作るドキュメントはというとまだ3番目にも到っていません。

  • どのように書いたらいいの

良いドキュメントの条件をすべて満たすにはどうすればいいのか。
ここで、さまざまな本の利点を挙げてみる。
これらの要素を合わせれば少しは良くなると思い込んでいます。

  • ラノベ
    • かわいい女の子が出てくる
    • 1人称視点
    • ストーリー調
    • パロディー
  • 外人の書いた技術書
    • ユニークな例
    • 有名な言葉の引用(章の最初に書いたり)
    • おもしろいジョーク

そのまま利用したらまずいのが含まれてる。
これらをどうにかしてドキュメントに含むことができればいいの書けるんじゃなかろうか。