1. Wikiを使ったナレッジ共有法
GitHubリポジトリには、Wiki(ウィキ)機能が備わっています。Wikiとは、複数人で編集できるウェブページ群のことで、知識ベースやドキュメントを整理するのに適しています。GitHubのWikiは各リポジトリに1セット付属し、リポジトリとは別に簡易的なCMSのようにページを作成・編集できます。
Wikiの特徴
業務において、Wikiは社内ナレッジ共有に大いに役立ちます。例えば「社内ツールの使い方」「業務手順書」「Q&A集」「部署の運営方針」など、頻繁に参照する情報をWikiにまとめておけば、常に最新の状態で全員が閲覧できます。GitHub WikiはGitと連動していますが、通常の操作はブラウザ上で行え、直感的に編集可能です。
Wikiの基本操作
Wikiページの作成
リポジトリ画面で「Wiki」タブを開き、「Create the first page」をクリックします。ページ名(タイトル)を入力し、本文をMarkdown形式で記述できます。
リンクの作成
普通のWikiと同様にリンクを貼ることができ、[[PageName]]
と書けばWiki内の他のページへのリンクになります。
編集と履歴
編集後、「Save Page」で保存すると履歴が記録されます。Wikiにも履歴(History)があり、過去の版や差分を確認できます。
ナビゲーション
右サイドバーには自動で目次(ページ一覧)が生成され、ページが増えるとその一覧がナビゲーションとして表示されます。
アクセス権
アクセス権はリポジトリと同様で、プライベートリポジトリのWikiは招待メンバーのみ編集・閲覧できます。
【画像: GitHubのWikiタブとページ作成画面のスクリーンショット】
Wikiの活用例
プロジェクト概要・方針
プロジェクトの概要や進め方の方針を説明するドキュメントとして活用できます。
よくある質問(FAQ)集
頻繁に聞かれる質問とその回答をまとめて、チームの効率を上げることができます。
手順書やマニュアル
長文になりがちな操作手順やマニュアルは、Wikiで整理すると見やすくなります。
会議の議事録まとめ
Issueで議論した内容の結果だけをWikiに整理して残すことができます。
Wikiの特長
IssueやPull Requestのコメントと違い、Wikiは整理された状態で情報を提供できます。また、コード管理のWikiという性質上、Markdownで表や画像も綺麗に載せられ、テキストエディタ感覚で使えます。
【画像: Wikiの編集画面と整形されたMarkdownの表示例】
技術系の会社では、エンジニア用ドキュメントをWikiに書く例は多くありますが、非エンジニアでも使いこなせるようUIはシンプルです。ポイントは適材適所で、議論はIssue、まとまった知識はWikiと使い分けることです。例えば「トラブル対応手順」をIssueで議論し固めたら、Wikiに正式手順としてページ化する、といった流れで使います。
Wikiのメリット
Wikiに蓄積された情報は検索もでき、後から参加したメンバーの教育にも有用です。常に最新の情報が整理された形で閲覧できるため、情報の鮮度と質を保ちながら知識共有が可能になります。