Skip to content

ステータス一覧 (STL) 作成の指示テンプレート

  • 以下のルールに従って、ステータス一覧(Status: STS) を 1 ファイル作成してください。出力は Markdown とします。

  • 対象は「状態(ステータス)の定義」です。詳細な状態遷移は CSTD 側で扱うため、本ドキュメントでは「状態の意味」「成立条件」「終了条件」を明確にしてください。

  • 禁止: 物理テーブル名・物理カラム名・SQL全文、実装クラス/関数名、APIの内部実装詳細、クリック手順など UI 操作の逐語列挙

  • 先頭に YAML Frontmatter を付与し、以下の形式で記述してください(不要な項目は省略可だが、id / type / title / status は必須):

    yaml
    ---
    id: sts-<英小文字とハイフンで構成したID> # 例: sts-money
    type: domain
    title: <ステータス一覧名> # 例: お金のステータス
    status: draft # draft / ready / deprecated のいずれか
    supersedes: []
    ---
  • 本文には、少なくとも次の見出し(日本語)と表を含めてください:

    1. ステータス定義
    2. ステータス一覧
  • ステータス定義「定義項目 / 内容」 の 2 列の表で記述し、次の定義項目(行)を含めてください:

    対象エンティティ / ステータス定義名 / 説明 / 状態遷移の観点

  • ステータス一覧 は表形式で、次の列を この順序 で必ず含めてください(後ろ 3 列は任意):

    値 / ステータス / 呼称 / 説明 / 系統(任意) / データストア(任意) / 保管場所(任意)

  • 「ステータス(正式名称)」は 用語集の term と一致 させてください(日本語単数形)。

  • 「値」はシステム上の識別子として lower-kebab-case を用いてください。

  • 「説明」には、状態の意味に加えて 成立条件(いつこの状態になるか)終了条件(次に進む条件) を簡潔に含めてください。

  • 任意列のうち「データストア」は、帳簿・台帳・DBなどの 記録・管理先 を業務用語で記載してください。

  • 略語のみの記述や、検証不能な曖昧表現は避け、業務用語で統一してください。