はじめに
READMEやドキュメントは既存のチームのサポートや将来的に参画する
新規メンバーのために定期的に整備すべき項目です。
GitHubの機能の中で、Organization向けにできる設定をいくつか紹介します。
ORganization向けのREADME
手順は以下の通りです
-
.github-privateというリポジトリを作成 -
profileディレクトリ作成 -
profileディレクトリにREADME.mdファイルを作成
Discussionによる意思決定プロセスの保存
GitHubにはDiscussion機能があり、要件について、ディレクトリ構造について、議事録などの情報を保存することができます。
もちろんある程度issueで会話することも可能ですが、Closeされたissueから情報を探すのは少し手間であるため、全体方針に関わる大事な議論が始まったらDiscussionで整理することを推奨します。
また、場合によっては会議の議事録等も保存しても良いでしょう。
Wikiで開発Tipsやプロジェクト方針についての情報などを保存する
GitHubのwiki機能は主にドキュメントの保存に有効です。
ただし、マークダウン形式限定のためものによっては扱いづらい部分もあるかと思いますが、
wikiはページの階層構造を作れたりするのでそう言った点でもおすすめです。
もちろん、ドキュメントの管理をGoogle WorkspaceやAttlasianに集約しても問題ありません。
例えば、プロジェクト全体に関するドキュメントは上記のようなサービスで保存をし、開発するエンジニア向けにはwikiを使うといったことも有効な使い方だと思います。
ただし、Discussion, Wikiの欠点としてOrganizationに直接設定できないです。
必ずどこかのリポジトリ上に作るしかありません。
そのため、
- それ用にリポジトリを作ってしまう
- 該当リポジトリのwiki, discussionに作成し、導線をOrganizationのREADMEに記載する
と言った手段が必要になります。
ただし、「開発コードとそれに関する情報が近い場所にある」ということは大切なことであるため多少煩わしさの中で扱う価値もあると思います。
以上がGitHubにドキュメント等を集約させるアイディアになります。
他にも良い機能があったら後日追記させていただきます！