README・コメント・コミットメッセージ・PR の説明・設計メモ・図・手順書・障害報告・問い合わせへの返信。全20レッスンで「実務で毎日書くもの」を、読み手の次の一手から決めて書けるところまで進みます。良い例はすべて実在のサービス(このサイト 4peiron.dev)の README・docs/・.github/ からの引用で、悪い例だけを書き下ろしています。
全20レッスンを5つの章に分けています。第1章から順に進めるのがおすすめですが、 気になるところだけ拾い読みしてもかまいません。 ※ 良い例はこのサイト(4peiron.dev)のリポジトリの現物です。git と Markdown の出力はすべて実際に動かしたもので、ブラウザ内では実行できないため、手元のターミナルで試してください。文章を測る Python と図の SVG は、その場で実行できます。
文章に手が止まる原因のほとんどは、書き方ではなく読み手が決まっていないことです。読み手・目的・合格条件を先に決め、短く・判定できる言葉で書き、Markdown で構造を作るところまで進みます。
README・コメント・コミットメッセージ・Pull Request の説明・Issue。コードと一緒に置く文章を、このサイト自身のリポジトリの現物と見比べながら書けるようになります。最後は不具合の報告を、再現手順から組み立てます。
実装前の設計メモ、選ばなかった案まで含めた決定の記録、図、そして「できないこと」の書き方。半年後に読む人が同じ判断にたどり着ける文章を作ります。最後は限界と前提を明示した一節を書きます。
そのとおりにやれば終わる手順書、症状から引ける「うまくいかないとき」の節、障害報告、問い合わせへの返信。読む人が急いでいる場面の文章をまとめて扱います。
書いた文章は放っておくと嘘になります。古くなった文章を機械で見つける方法と、人の文章にどう指摘を付けるかで締めくくります。最後は全20レッスンの見直し表を作ります。
全20レッスンを終えたら、書いた文章を履歴に残す Git & GitHub 入門コース や、要件定義書・設計書を工程として扱う システム開発入門コース へ。コードそのものを読めるように直すなら 設計とリファクタリング入門コース も。メンバーシップで全コースが解放されます。