実習サンプル(examples/)
このセクションでは、本書の実習で利用できる サンプルファイル(テンプレ・雛形) をまとめます。
サンプルはリポジトリの examples/ に配置しています。
examples/:https://github.com/itdojp/github-guide-for-beginners-book/tree/main/examples
収録内容
Docs-as-Code(文書運用)サンプル
- 推奨ディレクトリ構成(
docs/) - 文書テンプレ(ADR/議事録/設計/Runbook)
- Issue/PR のサンプル文面
docs/assets/(小さな添付・図解の置き場)
該当パス:examples/docs-as-code/
すぐ使えるテンプレ集
- README(入口ポータル)
docs/index.md(文書ポータル)- ラベル設計(増えすぎ対策の最小セット)
該当パス:examples/templates/
使い方(コピーして使う)
examples/から必要なフォルダを選びます。- 自分のリポジトリにコピーします。
- 目的に合わせて、目次(
docs/index.md)やテンプレの項目を調整します。
トップへ戻る: トップ