Skip to content

機能設計ドキュメント

設計書コード一覧(ID レジストリ)

すべて docs/design/一覧/ に置く。

設計書コード(ID レジストリ)

ファイル名は {prefix}-一覧.md

一覧ファイルプレフィックス設計書の置き場所
SC-一覧.mdSC-ショートコード/
PUB-一覧.mdPUB-公開画面/
ADM-一覧.mdADM-管理画面/画面設計書/
EP-一覧.mdEP-(admin-ajax)管理画面/admin-ajax/endpoints/
REQ-一覧.mdREQ-管理画面/同一管理画面リクエスト/
API-一覧.mdAPI-バックエンドAPI/
IF-一覧.mdIF-画面サーバIF/
CPT-一覧.mdCPT-カスタム投稿タイプ/

参照一覧(実装・運用)

ファイル内容
ショートコード一覧.mdショートコードタグ・入出力の参照表(設計書 ID は SC-一覧)
投稿タイプ一覧.mdカスタム投稿タイプの参照表(詳細は docs/posttypes/
画面一覧.mdPUB-一覧 への案内

ディレクトリ構成(カテゴリ別)

ディレクトリ置くもの
一覧/設計書コード(ID)レジストリ(*-一覧.md
資料フォーマット/ひな型・フォーマットガイド(テンプレート)
ショートコード/公開サイト用ショートコード関連の設計書
管理画面/WordPress 管理画面機能の設計書
公開画面/公開サイト上の画面単位の設計書
カスタム投稿タイプ/投稿タイプ登録・編集 UI などの設計書
バックエンドAPI/WordPress REST 等のサーバー側 API の設計書(JSON 契約)
画面サーバIF/サーバーがビュー/クライアント初期化へ渡すデータ構造(Presentation DTO、wp_localize_script 契約など)
テーブル定義/DBML 正本・カスタムテーブル集約・Issue 由来のテーブル設計メモ(案内