Appearance
機能設計ドキュメント
docs/design/ は、機能ごとの仕様、画面、API 契約、データ構造など、実装の参照元になる設計書を置くカテゴリです。docs 全体の整理方針は docs 整理ルール を参照してください。
このカテゴリに置くもの
- ショートコード、公開画面、管理画面、API、画面サーバ IF、カスタム投稿タイプ、バッチの機能別設計
- 設計書コード(ID)と論理名、概要、対応ファイルを管理する一覧
- 設計書フォーマット、テンプレート、テーブル定義など、設計書を支える正本
運用手順は 運用、環境構築や同期手順は 環境、障害調査は トラブルシューティング に置きます。
正本と役割
設計書配下では、次の3種類を分けて扱います。
| 種類 | 役割 | 主な置き場所 |
|---|---|---|
| 機能一覧 | 何が存在するかの台帳。ID、論理名、概要、対応ファイルを見る場所 | docs/design/一覧/ |
| 機能別設計 | 個々の仕様、画面、API 契約、データ構造を見る場所 | docs/design/{カテゴリ}/ |
| 設計書トップ | 書き方、置き場所、ID ルールを見る場所 | docs/design/README.md |
設計書の表示名は、ファイル名や SC / PUB / ADM などの管理用 ID ではなく、論理名を優先します。ID は一覧・検索・重複防止のための管理キーとして扱い、本文やリンク説明では「日別記事結果ショートコード」「日別記事(シングル)」「管理画面リクエスト」のような論理名を前面に出してください。
機能一覧
機能一覧は、設計書の台帳です。新しい機能別設計を追加したら、対応する一覧にも ID、論理名、概要、対応ファイルを追加します。
text
機能一覧
- ショートコード一覧
- 公開画面一覧
- 管理画面一覧
- admin-ajax エンドポイント一覧
- 管理画面リクエスト一覧
- バックエンド API 一覧
- 画面サーバ IF 一覧
- カスタム投稿タイプ一覧機能別設計
機能別設計は、個々の仕様を読む場所です。画面、API、ショートコード、バッチなど、利用者が探す論理名に合わせてカテゴリを選びます。管理用 ID はファイル名と一覧で管理し、本文の見出しや説明では論理名を優先します。
補助資料・履歴資料
補助資料は、設計判断の背景、テンプレート、過去メモなど、正本の理解を助ける資料です。現在の仕様として参照すべき内容は、補助資料だけに残さず、機能別設計または一覧へ反映してください。
設計書コード一覧(ID レジストリ)
すべて docs/design/一覧/ に置く。
設計書コード(ID レジストリ)
ファイル名は {prefix}-一覧.md。
| 一覧ファイル | プレフィックス | 設計書の置き場所 |
|---|---|---|
| SC-一覧.md | SC- | ショートコード/ |
| PUB-一覧.md | PUB- | 公開画面/ |
| ADM-一覧.md | ADM- | 管理画面/画面設計書/ |
| EP-一覧.md | EP-(admin-ajax) | 管理画面/admin-ajax/endpoints/ |
| REQ-一覧.md | REQ- | 管理画面/同一管理画面リクエスト/ |
| API-一覧.md | API- | バックエンドAPI/ |
| IF-一覧.md | IF- | 画面サーバIF/ |
| CPT-一覧.md | CPT- | カスタム投稿タイプ/ |
参照一覧(実装・運用)
| ファイル | 内容 |
|---|---|
| ショートコード一覧.md | ショートコードタグ・入出力の参照表(設計書 ID は SC-一覧) |
| 投稿タイプ一覧.md | カスタム投稿タイプの参照表(詳細は docs/posttypes/) |
| 画面一覧.md | PUB-一覧 への案内 |
ディレクトリ構成(カテゴリ別)
| ディレクトリ | 置くもの |
|---|---|
一覧/ | 設計書コード(ID)レジストリ(*-一覧.md) |
資料フォーマット/ | ひな型・フォーマットガイド(テンプレート) |
ショートコード/ | 公開サイト用ショートコード関連の設計書 |
管理画面/ | WordPress 管理画面機能の設計書 |
公開画面/ | 公開サイト上の画面単位の設計書 |
カスタム投稿タイプ/ | 投稿タイプ登録・編集 UI などの設計書 |
バッチ/ | WP-Cron・WP-CLI・保守用ジョブなど、画面から独立して実行される処理の設計書 |
バックエンドAPI/ | WordPress REST 等のサーバー側 API の設計書(JSON 契約) |
画面サーバIF/ | サーバーがビュー/クライアント初期化へ渡すデータ構造(Presentation DTO、wp_localize_script 契約など) |
テーブル定義/ | DBML 正本・カスタムテーブル集約・Issue 由来のテーブル設計メモ(案内) |