プロダクト仕様、設計資料、開発ルールを Markdown と Mermaid で管理します。GitHub またはエディタで閲覧・編集してください。ビルドやデプロイは行いません。
- API design
- すぐ使える、パスワード認証
- Database design
- System overview
- Technology stack
- フロントエンドの構成
- フロントエンドのファイル移行表
- Server State の管理
- CI 品質ゲート
- コード品質チェック運用
- フロントエンドコーディング規約
- ログインできるまでの設定マップ
- Development Docs
- ローカル検証手順
- Planning Workflow
- テスト運用
- フロントエンド構成移行の実行順と検証結果
- フロントエンドのテスト戦略
- 既存の分類に合わせて Markdown を追加し、この目次も更新する。
- 文書間のリンクは、拡張子
.mdを含む相対パスで記載する。 - 図は
mermaidコードブロックで記載し、GitHub または Mermaid 対応エディタで表示を確認する。 - 図を補足する説明や詳細な定義は、文章・表でも残す。
- 文書のタイトルと説明は本文に記載し、frontmatter は使用しない。
- 環境変数の変更時は、環境変数ガイド、対応する
*.example、アプリごとの README を同時に更新する。 pnpm format:checkと既存の Git Hooks・CI で Markdown の整形を確認する。