第3回まで無料

技術文章とドキュメント入門コース

README・コメント・コミットメッセージ・PR の説明・設計メモ・図・手順書・障害報告・問い合わせへの返信。全20レッスンで「実務で毎日書くもの」を、読み手の次の一手から決めて書けるところまで進みます。良い例はすべて実在のサービス(このサイト 4peiron.dev)の README・docs/・.github/ からの引用で、悪い例だけを書き下ろしています。

カリキュラム

全20レッスンを5つの章に分けています。第1章から順に進めるのがおすすめですが、 気になるところだけ拾い読みしてもかまいません。 ※ 良い例はこのサイト(4peiron.dev)のリポジトリの現物です。git と Markdown の出力はすべて実際に動かしたもので、ブラウザ内では実行できないため、手元のターミナルで試してください。文章を測る Python と図の SVG は、その場で実行できます。

Chapter 1 — 読み手を決める(第1〜4回)

文章に手が止まる原因のほとんどは、書き方ではなく読み手が決まっていないことです。読み手・目的・合格条件を先に決め、短く・判定できる言葉で書き、Markdown で構造を作るところまで進みます。

Chapter 2 — コードに添える(第5〜10回)

README・コメント・コミットメッセージ・Pull Request の説明・Issue。コードと一緒に置く文章を、このサイト自身のリポジトリの現物と見比べながら書けるようになります。最後は不具合の報告を、再現手順から組み立てます。

5

README は「動かすまで」を書く

README の合格は、初見の人が質問なしで起動できること。実在のサービスの README を分解して、貼れば動くコマンド列と「公開前に必ず設定するもの」の書き方を見る。

🔒 ベーシック
6

コメントとドキュメント文字列(なぜ、と、できないこと)

コードを読めば分かることは書かない。書くのは、選ばなかった案・破れる前提・仕様の根拠。実在のモジュールの冒頭コメントを読む。

🔒 ベーシック
7

コミットメッセージの 1 行目

1行目は一覧に並ぶ見出し。動詞で終える・1文で書く・50字前後に収めるの3つと、git blame から辿ったときに何が起きるかを実際の出力で見る。

🔒 ベーシック
8

コミットメッセージの本文(なぜ、を残す)

本文は git blame から辿り着く場所。症状・原因・選んだ対処・残した課題の4つを書く。blame で出たコミットを開いたときの差を実際の出力で見る。

🔒 ベーシック
9

Pull Request の説明(レビュアーの時間を買う)

PR の説明は、レビューにかかる時間を減らすために書く。実在のテンプレートを分解し、チェック欄が嘘になる条件を確かめる。悪い説明を直す演習つき。

🔒 ベーシック
10

Issue を書く(再現手順が時間を買う)

不具合の報告で効くのは再現手順、要望で効くのは「なぜ」。実在のひな形を読み、プランやログイン状態で挙動が変わるサービスで何を書くべきかを見る。

🔒 ベーシック

Chapter 3 — 仕様と設計を残す(第11〜14回)

実装前の設計メモ、選ばなかった案まで含めた決定の記録、図、そして「できないこと」の書き方。半年後に読む人が同じ判断にたどり着ける文章を作ります。最後は限界と前提を明示した一節を書きます。

Chapter 4 — 運用で書く(第15〜18回)

そのとおりにやれば終わる手順書、症状から引ける「うまくいかないとき」の節、障害報告、問い合わせへの返信。読む人が急いでいる場面の文章をまとめて扱います。

Chapter 5 — 保守する(第19〜20回)

書いた文章は放っておくと嘘になります。古くなった文章を機械で見つける方法と、人の文章にどう指摘を付けるかで締めくくります。最後は全20レッスンの見直し表を作ります。

全20レッスンを終えたら、書いた文章を履歴に残す Git & GitHub 入門コース や、要件定義書・設計書を工程として扱う システム開発入門コース へ。コードそのものを読めるように直すなら 設計とリファクタリング入門コース も。メンバーシップで全コースが解放されます。