コンテンツにスキップ

🏢 リツビ BtoB ECサイト ドキュメントポータル

リツビ BtoB ECサイトの要件・設計・実装・運用資料を横断する全体ポータルです。まずは優先読者ごとの導線から入り、検収・納品・運用・引き継ぎで共有する資料は 05. 納品・運用ポータル へ進んでください。

👥 優先読者の入口

検収担当

システム管理者・運用担当

WordPress CMS担当

引き継ぎ開発者・保守担当

🧭 全体ポータルと納品導線の関係

  • docs/index.md は、社内で扱う広い資料群を横断する総合入口です。
  • docs/05-delivery/index.md は、検収・運用・引き継ぎで共有する主導線です。優先読者はまずこちらへ案内します。
  • Cloudflare Pages 上のドキュメントサイトは、顧客共有用に絞った導線として扱います。対象は検収・管理運用に必要な資料を中心とし、引き継ぎ資料の確認は docs/05-delivery/ と公式納品物 PDF を基準にします。
  • 公式納品物として扱う仕様書一式は、.mkdocs/spec.yml から出力する PDF を基準に確認します。

🎯 目的から選ぶ

👥 その他の役割別クイックアクセス

🗂️ セクション別ガイド

セクション 主な内容 代表資料 主な対象
00. 元仕様書 PDF / Excel / DOCX などの一次情報 元仕様書ポータル 全員
01. 要件定義 整理済み要件、補足要件、トレーサビリティ 統合要件書 PM、検収担当、開発者
02. 設計仕様 アーキテクチャ、UI指針、購入フロー設計 設計仕様ポータル デザイナー、開発者
03. 実装仕様 Vendure / Storefront / インフラの実装詳細 実装仕様ポータル 開発者、運用担当
04. プロジェクト管理 スケジュール、進捗、会議録、要件変更管理 プロジェクト管理ポータル PM、リード、検収担当
05. 納品・運用 利用者向け手順、保守、バックアップ、引き継ぎ 納品・運用ポータル 利用者、運用チーム
06. 追加機能 基本スコープ外の追加開発候補 追加機能ポータル PM、事業側、開発者
07. Frontend UI ルール、共通コンポーネント、UI プレビュー Frontend ガイド Frontend 開発者

引き継ぎでコードベースの全体構造、外部依存、確認の起点を先に押さえたい場合は、引き継ぎ向けコードベース全体像 を参照してください。

🔄 主要ポータルの関係

flowchart TD
  portal[docs/index.md
ドキュメントポータル] --> overview[project-overview.md
背景と対象範囲]
  portal --> specs[specifications/index.md
原資料]
  portal --> req[01-requirements/index.md
整理済み要件]
  portal --> design[02-design/index.md
設計判断]
  portal --> impl[03-implementation/index.md
実装詳細]
  portal --> pm[04-project-management/index.md
進捗・合意事項]
  portal --> ops[05-delivery/index.md
利用・運用]

  req --> specs
  impl --> design
  pm --> req
  pm --> ops
  ops --> userManual[manual/user-manual.md]
  ops --> maintenance[maintenance/system-maintenance.md]
  ops --> handover[handover/technical-handover.md]

現在の判断や説明に使う資料は、このポータルから各セクションの index.md に入り、そこから詳細へ辿る運用を基本とします。

📚 リファレンス & 更新ルール

参照先 用途
開発標準・ツール 技術標準、CI / Hook、運用ルールの確認
ドキュメント運用ルール ドキュメント配置、命名、更新時の基本方針
ドキュメント運用ガイド リポジトリ上で参照する docs/ 配下の役割分担と更新フロー
専門用語集 プロジェクト固有用語の統一
参考資料リンク集 外部サービス、決済、監視、関連資料の参照

🛠️ 更新時の確認（定期メンテナンス）

  • 要件の根拠は必ず specifications/ を起点に確認する。
  • 新しい資料を追加したら、該当セクションの index.md と MkDocs ナビゲーションを同期する。
  • 監視の同期: Sentry Workflow / Uptime 設定が observability/*.json 正本と同期されているか確認する。
  • プラグインの網羅: 新規プラグイン追加時、03-implementation/vendure-plugins/index.md へリンクを追記する。
  • パスの整合性: コード例が最新のフォルダ構成（packages/plugins/src/...）と一致しているか確認する。
  • 検証時は pnpm exec markdownlint-cli2 "docs/**/*.md" "README.md" と just docs-build を利用する。