技術ドキュメントに何を書くか | Oddwit
テクニカルなドキュメントを書くなら何を書くべきか、という記事。 Writing great documentation: what to write. チュートリアルを作れ 素早いのを：使い手が20分以内に何かしら達成感を得られるように 簡単なのを：Foolproofな内容にしておく ただし能力不十分な人は挫折させるようにする その技術の大体の「感じ」が掴めるように、いろんな側面を見せる トピックガイドを作れ よくあるユースケースを網羅する これだけ見れば使い方が分かるようにする リファレンスを作れ トピ... > このページを見る
はてなブックマーク
