Skip to content

要件定義書

項目内容
文書番号RD-001
版数1.0
作成日2026-06-12
作成Claude Code(実装担当)
承認けんぞ(PM)

1. 背景・課題

プロジェクトの情報共有において、次の問題が起きている。

  • md ファイルの増殖:設計メモ・手順書・議事録・学び記録が md で量産される。AI コーディング支援(Claude Code 等)の普及で生成速度がさらに上がった
  • 可読性の低さ:md の山はエディタや git のファイル一覧でしか俯瞰できず、関係者が「どこに何があるか」を把握できない
  • HTML の手作り増加:読みやすさを求めて HTML 資料を個別に作る人が増え、正本が分裂し始めている
  • wiki の廃墟化:過去に導入した wiki ツールは、転記・整形の手間が人間任せだったため更新が止まった

書くコストは下がったのに、読む・探すコストが下がっていない。これが解決したい本質的な課題である。

2. 目的

正本を md + git に一本化したまま、人間向けの読み口(サイト)を自動生成する。サイトの管理作業を「ファイルを置く」だけに圧縮し、更新が止まらない仕組みを作る。

3. 用語定義

用語定義
正本唯一の信頼できる原稿。本システムでは docs/ 配下の md ファイル
読み口人間が閲覧するための表示形態。本システムでは自動生成される静的サイト
増築ディレクトリにファイルを追加してサイトを拡張すること

4. 利用者定義

利用者種別主な行動
閲覧者人間サイトで成果物を読む・検索する
編集者人間md を追加・修正して増築する
増築者AI(Claude Code 等)指示を受けて md を生成・修正し、ビルド検証まで行う

AI を正式な利用者として定義する点が本システムの特徴である。md + git という正本形式は、AI が直接読み書きできる。

5. 機能要件

ID要件備考
FR-01docs/ 配下に md を置くと、ページとサイドバー項目が自動で生成されることディレクトリ構造=サイトマップ
FR-02サイドバーの表示名は md の frontmatter title:(日本語)を反映することURL は英語スラグのまま
FR-03日本語で全文検索ができること追加サービス契約なし
FR-04サイト内リンクの切れをビルド時に自動検出し、ビルドを失敗させることリンク切れの混入防止
FR-05スマートフォンでも閲覧できることレスポンシブ
FR-06公開 URL でチームに共有できることアクセス制限は段階導入(リリース計画書 Step3)

6. 非機能要件

ID要件目標値
NFR-01運用コスト月額 0 円(ホスティング無料枠内)
NFR-02ビルド時間60 秒以内
NFR-03学習コストmd が書ければ増築できる。サイト生成ツールの知識を編集者に要求しない
NFR-04セットアップ時間ゼロから公開まで半日以内
NFR-05可搬性正本が md のため、生成ツールを将来乗り換えても資産が残ること

7. 制約事項

公開範囲の制約(最重要)

公開 URL(*.pages.dev)は誰でも閲覧可能。機密情報・実在の取引先名・個人情報は置かないリリース計画書の公開前チェックリストで担保)。

  • アクセス制限が必要になった時点で Cloudflare Access(50 ユーザーまで無料)を設定する

8. 受入基準

テスト計画書に定める T-01〜T-06 がすべて合格であること。

変更履歴

日付変更内容
1.02026-06-12初版作成