公開 / 社内を分離
顧客も読めるハンドブック（公開）と、開発仕様を書く社内 Wiki（INTERNAL）を 1 つの場所で。
PJERP — Wiki / オンボーディング手順
LIVING⚠ 90 日未確認
開発環境のセットアップ
1. リポジトリを clone
2. .env を取得して配置
3. npm install && npm run dev
最終確認: 3 か月前最近確認
ページ種別
“いつの情報か”を、種別で示す
すべてのページを同じに扱わない。性質に応じた 3 つの種別で、ナレッジの信頼性をコントロールします。
LIVING
生きた手順書
運用マニュアルなど更新され続ける文書。一定期間確認されないと「古いかも」と警告し、放置を防ぎます。
REFERENCE
リファレンス
API 仕様や設定値など、参照するための文書。変わりにくい情報を整理して置いておけます。
DECISION
意思決定記録
なぜその設計にしたかを残す ADR。時間が経っても「決めた理由」を辿れます。
運用に効く、Wiki の機能
階層ツリー構造
親子ページでナレッジを体系化。ドラッグ&ドロップで並べ替えできます。
鮮度バッジ
最終確認日を記録し、古くなったページを可視化。「最近確認」ボタンで鮮度を更新します。
編集履歴
編集のたびにスナップショットを保存。過去のリビジョンをいつでも参照できます。
横断検索に対応
⌘K の横断検索で Wiki も対象に。タイトル・本文から目的のページへ即移動。
課題・Wiki を相互リンク
本文から [[Wiki ページや #課題をメンション。ナレッジと作業が地続きになります。
顧客向けと社内向けを、
ひとつの本棚に
「顧客に見せるマニュアル」と「開発者だけの仕様メモ」を別ツールに分ける必要はありません。 同じプロジェクト内で、公開ハンドブックと社内 Wiki を可視性で切り替えるだけ。
- 📘 ハンドブック（公開）— 顧客も閲覧できるマニュアル
- 🔒 Wiki（社内）— 設計・仕様メモは管理者だけ
- 社内 Wiki は顧客の検索結果にも現れない
- リッチテキスト（見出し・表・画像・コード）対応