ソフトウェアチュートリアルを書くためのルール
ソフトウェアチュートリアルの多くは、重要な詳細の欠落や暗黙の前提により読者が再現できずに失敗している。しかし、いくつかのシンプルなルールに従うだけで、優れたチュートリアルを書くことは可能だ。初心者向けの記述、明確なゴール設定、再利用可能なコードの分離、依存関係の最小化など17のルールを紹介する。
ソフトウェアチュートリアルの多くは、重要な詳細の欠落や暗黙の前提により読者が再現できずに失敗している。しかし、いくつかのシンプルなルールに従うだけで、優れたチュートリアルを書くことは可能だ。初心者向けの記述、明確なゴール設定、再利用可能なコードの分離、依存関係の最小化など17のルールを紹介する。