[GitHub 100日チャレンジ] Day 77 - GitHub Wikiの応用
GitHub Wikiを構造化し、リンク、目次、更新ルールを整えて、チームで使い続けられるドキュメントにする方法を学びます。
[GitHub 100日チャレンジ] Day 77 - GitHub Wikiの応用
Wikiを育てる
Wikiは作って終わりではありません。ページが増えるほど、構造と更新ルールが重要になります。
ページ構成を決める
おすすめは、目的別に分けることです。
- Getting Started
- Architecture
- Development
- Operations
- Troubleshooting
ページ名の規則をそろえると検索しやすくなります。
内部リンクを使う
関連ページ同士をリンクすると、読む人が迷いにくくなります。
1
2
See also: [[Release Guide]]
See also: [[Troubleshooting]]
更新ルールを置く
古いWikiは混乱の元になります。ページの最後に更新日や担当領域を書いておくと、見直しやすくなります。
今日のゴール
Wikiはチームの記憶です。ページ構成、内部リンク、更新ルールを整えて、後から読む人が迷わない状態にしましょう。
この投稿は投稿者によって CC BY 4.0 の下でライセンスされています。
