mcpField
S
speckit-plan-zh

speckit-plan-zh

github.com/forztfDevelopment10312 installsUpdated 48w ago
Repository

About speckit-plan-zh

speckit-plan-zh is an implementation-planning skill for Spec Kit feature development. It uses a feature specification and project constitution to produce research and design artifacts, then stops after planning through phase 2.

Key features

  1. 01Loads the feature spec, constitution, and plan template
  2. 02Identifies technical questions needing clarification
  3. 03Produces a research decisions document
  4. 04Creates data models and API contracts
  5. 05Updates agent context and checks constitution rules

Use cases

  1. 01Create an implementation plan from a feature spec
  2. 02Document technical choices and alternatives
  3. 03Derive entities and API contracts from requirements

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/forztf/open-skilled-sdd --skill speckit-plan-zh

After installing, type/speckit-plan-zhin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

assets/
key-rules.md
phase0-research.md
phase1-design.md
plan-template.md
setup-workflow.md
references/
technical-context.md
scripts/
execute-workflow.ps1
setup-plan.ps1
update-agent-context.ps1
scripts/bash/
check-prerequisites.sh
common.sh
create-new-feature.sh
setup-plan.sh
update-agent-context.sh
scripts/powershell/
check-prerequisites.ps1
common.ps1
create-new-feature.ps1
setup-plan.ps1
update-agent-context.ps1

Details

From the project README

用户输入

$ARGUMENTS

在继续之前,您必须考虑用户输入(如果不为空)。

大纲

  1. 设置: 从仓库根目录运行 .specify/scripts/powershell/setup-plan.ps1 -Json 并解析 JSON 以获取 FEATURE_SPEC、IMPL_PLAN、SPECS_DIR、BRANCH。对于参数中的单引号,如 "I'm Groot",请使用转义语法:例如 'I'''m Groot'(或者如果可能的话使用双引号:"I'm Groot")。

  2. 加载上下文: 读取 FEATURE_SPEC 和 .specify/memory/constitution.md。加载 IMPL_PLAN 模板(已复制)。

  3. 执行计划工作流程: 遵循 IMPL_PLAN 模板中的结构来:

    • 填写技术上下文(将未知项标记为"需要澄清")
    • 从章程中填写章程检查部分
    • 评估门禁(如果有未正当化的违规则报错)
    • 阶段 0: 生成 research.md(解决所有"需要澄清")
    • 阶段 1: 生成 data-model.md、contracts/、quickstart.md
    • 阶段 1: 通过运行代理脚本更新代理上下文
    • 设计后重新评估章程检查
  4. 停止并报告: 命令在阶段 2 规划后结束。报告分支、IMPL_PLAN 路径和生成的工件。

阶段

阶段 0: 大纲与研究
  1. 从上述技术上下文中提取未知项:

    • 对于每个"需要澄清" → 研究任务
    • 对于每个依赖项 → 最佳实践任务
    • 对于每个集成 → 模式任务
  2. 生成并分发研究代理:

    对于技术上下文中的每个未知项:
      任务: "研究 {未知项} 用于 {功能上下文}"
    对于每个技术选择:
      任务: "查找 {技术} 在 {领域} 中的最佳实践"
    
  3. 在 research.md 中整合发现结果,使用格式:

    • 决策: [选择了什么]
    • 理由: [为什么选择]
    • 考虑的替代方案: [还评估了什么]

输出: 解决了所有"需要澄清"的 research.md

阶段 1: 设计与契约

前提条件: research.md 完成

  1. 从功能规格中提取实体 → data-model.md:

    • 实体名称、字段、关系
    • 来自需求的验证规则
    • 如适用的状态转换
  2. 从功能需求生成 API 契约:

    • 对于每个用户操作 → 端点
    • 使用标准的 REST/GraphQL 模式
    • 将 OpenAPI/GraphQL 模式输出到 /contracts/
  3. 代理上下文更新:

    • 运行 .specify/scripts/powershell/update-agent-context.ps1 -AgentType claude
    • 这些脚本检测正在使用的 AI 代理
    • 更新相应的代理特定上下文文件
    • 仅添加当前计划中的新技术
    • 保留标记之间的手动添加内容

输出: data-model.md、/contracts/*、quickstart.md、代理特定文件

关键规则

  • 使用绝对路径
  • 如果检查点失败或存在未解决的澄清项,则报 ERROR

Comments

Markdown supported