speckit-require

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Requirements Spec Kit

Requirements Spec Kit

Overview

Overview

GitHub Spec Kit のリポジトリ内テンプレートとスクリプトを使い、要件定義を作成・更新して spec.md → plan.md → tasks.md を完成させる。新規作成か既存追記かを判断し、対象 SPEC を確定してから作業する。
Use the templates and scripts in the GitHub Spec Kit repository to create and update requirement definitions, and complete spec.md → plan.md → tasks.md. Determine whether to create a new one or append to an existing one, and confirm the target SPEC before starting work.

決定フロー: 新規作成 or 既存追記

Decision Flow: Create New or Append to Existing

  • ユーザー入力で即決する: SPEC-ID、spec.md パス、または「追記/既存」指示があれば追記する。
  • 迷う場合は既存 SPEC を検索する:
    rg -n "# 機能仕様:" specs/SPEC-*/spec.md
    と主要キーワードで一致確認する。
  • 一致が1件なら追記する。複数一致なら候補(SPEC-IDとタイトル)を提示して選択を求める。
  • 一致が無ければ新規作成する。
  • 追記時は対象 SPEC の worktree/feature ブランチで作業する(
    .specify/scripts/bash/check-prerequisites.sh
    は最新 SPEC を選ぶため)。
  • Decide immediately based on user input: Append if there is a SPEC-ID, spec.md path, or "append/existing" instruction.
  • If unsure, search for existing SPECs: Confirm matches using
    rg -n "# 機能仕様:" specs/SPEC-*/spec.md
    and main keywords.
  • If there is exactly one match, append to it. If there are multiple matches, present the candidates (SPEC-ID and title) and ask for selection.
  • If no matches are found, create a new one.
  • When appending, work in the worktree/feature branch of the target SPEC (
    .specify/scripts/bash/check-prerequisites.sh
    is used to select the latest SPEC).

ワークフロー(specify → clarify → plan → tasks)

Workflow (specify → clarify → plan → tasks)

1) specify

1) specify

  • .specify/templates/commands/specify.md
    を読み、記載のスクリプトを1回実行する。
  • .specify/templates/spec-template.md
    を用いて spec.md を日本語で埋める。
  • 新規作成時はスクリプト出力の
    WORKTREE_PATH
    に移動して以降の作業を行う。
  • 既存追記時は該当セクションのみ更新し、見出し順・FR番号などの連番を維持する。
  • TDD/テスト要求がある場合は、要件または成功基準に「自動テストが必須」である旨を明記する。
  • specs/specs.md
    を更新し、優先度状態を必ず記載する(
    update-spec-index.sh
    を使う場合も同様)。
  • Read
    .specify/templates/commands/specify.md
    and execute the script described once.
  • Use
    .specify/templates/spec-template.md
    to fill in spec.md in Japanese.
  • When creating a new SPEC, move to the
    WORKTREE_PATH
    output by the script before proceeding with subsequent work.
  • When appending to an existing SPEC, only update the relevant sections and maintain sequential numbers such as heading order and FR numbers.
  • If TDD/test requirements are specified, clearly state that "automated testing is required" in the requirements or success criteria.
  • Update
    specs/specs.md
    , and be sure to include priority and status (the same applies when using
    update-spec-index.sh
    ).

2) clarify

2) clarify

  • .specify/templates/commands/clarify.md
    に従う。
  • 質問は最大5つに抑え、推奨回答を提示する。
  • 回答は spec.md の該当セクションへ即時反映する。
  • Follow
    .specify/templates/commands/clarify.md
    .
  • Limit questions to a maximum of 5 and present recommended answers.
  • Immediately reflect the answers in the corresponding sections of spec.md.

3) plan

3) plan

  • .specify/templates/commands/plan.md
    に従う。
  • .specify/memory/constitution.md
    を参照し、ゲート評価を満たす。
  • 出力(plan.md / research.md / data-model.md / quickstart.md / contracts/)を生成する。
  • Follow
    .specify/templates/commands/plan.md
    .
  • Refer to
    .specify/memory/constitution.md
    to meet the gate evaluation requirements.
  • Generate outputs (plan.md / research.md / data-model.md / quickstart.md / contracts/).

4) tasks

4) tasks

  • .specify/templates/commands/tasks.md
    に従う。
  • TDD/テスト要求がある場合はテストタスクを必ず含める。
  • tasks.md のチェックリスト形式(ID/Story/ファイルパス)を厳守する。
  • Follow
    .specify/templates/commands/tasks.md
    .
  • If TDD/test requirements are specified, be sure to include test tasks.
  • Strictly adhere to the checklist format (ID/Story/File Path) of tasks.md.

出力の報告

Output Reporting

  • 生成/更新した spec.md、plan.md、tasks.md のパスを報告する。
  • 未解決の明確化が残る場合は、ユーザー回答を得てから次へ進む。
  • Report the paths of the generated/updated spec.md, plan.md, and tasks.md.
  • If there are unresolved clarifications, obtain user answers before proceeding.