Skip to content

このファイルはテンプレートです。先に docs/design/一覧/一覧ファイルdocs/design/バックエンドAPI/ のみ API-一覧 への行追加、それ以外は対応する 一覧/SC-一覧.md / 一覧/ADM-一覧.md 等へ行を追加)し、設計書コード(ID)を確保してから 複製する。保存先の例は docs/design/ショートコード/docs/design/公開画面/docs/design/管理画面/docs/design/カスタム投稿タイプ/docs/design/バックエンドAPI/、および境界データ構造の docs/design/画面サーバIF/(必要な場合)など、一覧と README のディレクトリ構成 に沿ったカテゴリ。設計書コードのプレフィックスは SC-* / PUB-* / ADM-* / EP-* / REQ-* / API-* / IF-* / CPT-* のいずれかとし、README・.cursor/rules/design-doc-guidelines.mdc と整合させる。日本語ファイル名.md として保存し、見出し・プレースホルダーを置き換えてください。

概要

  • (ユーザー価値と振る舞いを箇条書きで。2〜5 項目目安。外部システムや別設計書に委ねる処理は名前だけ触れ、詳細はリンク先へ。)
  • (必要なら続ける。単一段落で書く場合はこの箇条書きをやめて段落にまとめてよい。)

外部インターフェース

(ショートコード以外の設計書では、見出しを REST エンドポイント管理画面 URL などに差し替える。)

ショートコードタグ

  • タグ名: [xxx]
  • 入力例: [タグ名 属性="値"]

属性一覧

属性役割必須
なし

(属性がある場合は上表を置き換える。)

エラー

(境界条件は「条件」列に含めて表にまとめる。見出しは ## エラー のみでよい。下表と同じ 3 列で行を追加する。)

条件ユーザー向け挙動メッセージ / ログ
必須属性がないショートコード出力を非表示{ショートコード名}xxx が指定されていない
属性の値が不正(形式・範囲)ショートコード出力を非表示{ショートコード名}xxx が不正です
処理中の Throwable など固定文言(例: エラーが発生しました:execute_if_not_adminerror_log(例: ShortCodeHelper、先頭 [ShortCodeHelper]
(他の境界・失敗パターン)(非表示 / 部分表示 / 固定文言 など)Messages::... / / ログのみ)

更新不可とみなすもの(git管理外の内容に依存し、リポジトリだけでは追従できない依存)

  • ショートコード名 xxx を変更しない
    • 理由: 過去投稿本文に文字列が直書きされているため
  • 属性名REST の path画面の固定文言 など。変更可否と 理由 を箇条書きで記載。)
  • (マークアップ・スクリプト handle 名など、外部が依存するものは具体的に列挙。)