-
Notifications
You must be signed in to change notification settings - Fork 0
【手引】Github Wikiの運用
のむら屋ごろう edited this page Jul 10, 2020
·
2 revisions
ページを作る際は、README.mdと同様に改行に気をつける必要がある。
READMEリポジトリ内Wikiを参考にする。
ページを作ればその分だけ膨らむので、Pagesを展開した時にタイトルで分類する努力をすべき。
たとえば、このページは「【手引】Github Wikiの運用」というタイトルで、【タグ】のようにして分類ごとにページを集めるようにしている。
Githubの上ナビゲーションのWikiを押したら一番最初に表示される。
このページだとここ
README.mdのようなもの。
表紙と目次だけにとどめておくべきページ。
Pageの項目はアコーディオンになっているのと、ページが増えれば増えるほど膨らんでしまうので、必要なページを適宜設定してあげるのが良い。
ページナビゲーション的な役割をもたせると良い。
各ページを読み終わったユーザーのために用意する。
- ネットサーフィンに慣れているユーザーやエンジニアには不要だが、そうでない人に向けて書いてあげるのが望ましい。
- 端末によってレイアウトが異なる事を考慮して共通な情報を添えるのが望ましい。
更新内容や履歴（ノウハウ）が蓄積しにくいので、wiki自体を管理する必要があれば別立てしたほうがよい。
とはいえ、必要な機能は揃っているので、敢えてwiki以外で対応する必要性は薄い。
外部公開（編集を目的としない）をする場合は、デザインやレイアウトの問題もあろうなのでGithub Pagesを使った方が良いかもしれない。
（Netlifyなど外部ホスティングサービスを使うケースも想定）