SuperAPI AI 工具集
合作ENAI 行业资讯收藏
Skill 广场01-initialize-srs

01-initialize-srs

写作与研究

查看项目

更新于 10-16 07:08

技能介绍

用途

该技能用于创建瀑布式 SRS 工作区，选择规格说明书结构，并建立标识符与来源上下文。它在运行其他 SRS 技能之前启动父项目，通过工业模板捕获愿景、功能、技术约束、业务规则、质量标准与术语定义。初始化完成后，可使用 context-engineering 对边界与参与者进行建模。

主要能力

  • 初始化或刷新 projects/<ProjectName>/_context/，包含六个模板：vision、features、tech_stack、business_rules、quality_standards、glossary。
  • 确保 projects/<ProjectName>/<phase>/<document>/ 目录在下游 IEEE/ISO 技能执行前存在。
  • 提供自动化脚本 init_skill.py 与 logic.prompt，同时支持 Claude 在不依赖 Python 或 logic.prompt 的情况下直接执行技能。
  • 支持维护模式（添加缺失模板，不覆盖用户编辑）与清理模式（删除并重新填充，仅在需要全新基线时使用）。
  • 记录每个目录操作与模板复制/跳过，并输出显式路径。
  • 内置反幻觉保护：不得生成、编造或假设 _context/ 文件中未明确存在的需求、干系人名称、功能或系统行为；缺失字段标记为 [CONTEXT-GAP: <file> is missing <field>]。

使用方式

在该目录下运行 python init_skill.py，或通过技能运行器调用 logic.prompt。自动化会检查 projects/<ProjectName>/_context/ 是否存在，并提供维护模式或清理模式选择。配置完成后，若 projects/<ProjectName>/<phase>/<document>/ 缺失则创建。模板从 templates/ 复制，每个模板内嵌专家指导注释、SHALL/MUST 措辞以及对齐的 Markdown 表格。完成后输出提示：“最终 SRS 的质量完全取决于这些文件的技术密度。避免模糊语言；提供具体数字与模型。” 若所需辅助文件（logic.prompt、Python 脚本）在环境中不可用，Claude 可直接执行技能：读取 projects/<ProjectName>/_context/ 下所有文件，按手动执行步骤操作（或让 Claude 内联描述上下文以生成相关 SRS 部分），并将输出写入 projects/<ProjectName>/02-requirements-engineering/01-srs/<section-file>.md。

适用场景

当所需来源工件可用，且初始化的 SRS 工作区与清单是下一项生命周期交付物时使用。适用于创建瀑布式 SRS 工作区、选择规格说明书结构、建立标识符与来源上下文等场景。当 context-engineering 拥有决策或交付物所有权时不适用。不得虚构缺失的项目证据、标准条款、阈值或干系人决策。

所需输入

必需：项目简报、方法论决策、上下文文件、标准配置文件和代码仓库路径。来源为发起人、项目上下文与方法论选择。缺失时：停止受影响步骤，指明缺失来源，仅返回合格缺口记录。

工作流

  1. 检查所需输入，记录精确来源、版本与未解决假设。
  2. 应用本技能现有领域工作流与决策规则，产出初始化的 SRS 工作区与清单。
  3. 当必需来源、有责决策人或确定性测试 oracle 缺失时停止。
  4. 恢复时保留有效工作，标记受阻范围，返回最窄的合格工件及下一步所需证据。

输出与验收

输出：初始化的 SRS 工作区与清单。消费者：上下文工程与需求作者。验收条件：所需章节已填充，来源链接可解析，每个实质需求或决策都有可观察的评审或测试 oracle。

证据产出：针对初始化的 SRS 工作区与清单的来源、决策、追踪与验证记录。评审者：需求质量评审员。验收条件：使用的输入、做出的决策、运行的检查、失败项与未评估项均明确可见。

能力与权限边界

读取与搜索为必需。仅当请求授权创建或修复指定需求工件时才允许编辑。发布、生产变更、破坏性操作、支出与认证需要明确授权。

降级模式

若所需文件、评审者、标准来源、网络检查、渲染器或执行能力不可用，返回最窄的有用合格结果，并将受影响检查标记为未评估；绝不将未评估检查转为通过。

决策规则

  • 方法论、项目身份或真实来源路径未解决：停止初始化并记录缺失决策。避免在错误结构或项目中创建 SRS。
  • 所需输入与测试 oracle 完整：继续现有工作流并记录证据。避免验收无法复现的交付物。
  • 强制来源或负责人缺失：停止受影响分支并发出合格缺口记录。避免虚构上下文或未授权决策。

质量标准

保持稳定标识符与从项目证据到初始化的 SRS 工作区与清单及其验收检查的双向追踪。仅在具有命名度量、方法、阈值、证据来源与负责评审者时应用 ISO/IEEE 度量；发布前运行反低质门。

反模式

  • 从假设上下文产出初始化的 SRS 工作区与清单。修复：引用项目来源或将范围标记为受阻。
  • 接受无确定性 oracle 的实质需求。修复：添加可测量结果、边界与验证方法。
  • 未经路由决策便跨界进入 context-engineering。修复：交接命名输入并保留追踪链接。
  • 将不可用检查视为通过。修复：标记为未评估并说明发布后果。
  • 无证据宣称标准、法定或干系人批准。修复：引用来源与评审者或限定该声明。

资源

README.md：技能描述、ISO/IEC 对齐、模板列表与参考。init_skill.py：处理目录检查、维护/清理模式、模板复制与日志的 Python 自动化。logic.prompt：描述期望行为、标准引用与日志需求的 LLM 指令。templates/：六个工业模板（vision.md、features.md、tech_stack.md、business_rules.md、quality_standards.md、glossary.md），每个包含专家指导注释与可测量数据的占位符。

常见陷阱

  • 未选择维护模式便重跑技能可能删除工作；仅在模板必须重置时使用清理模式。
  • 跳过模板填充会使下游技能缺少可验证输入；确保愿景、质量与业务规则文件在继续前包含可测量目标。
  • 遗漏 quality_standards.md 中角色特定的验收标准或术语定义会削弱 ISO/IEC 对齐；保持这些章节更新为可追踪引用。

Royce 的五项关键步骤与六份规范文档

Royce 原始论文明确指出基本顺序瀑布（分析→设计→编码→测试）“有风险且招致失败”。其真正贡献是五项纠正步骤，瀑布成功需全部具备：

  1. 设计先行：初步程序设计（存储、时序、接口）必须在分析开始前存在；_context/ 须在 tech_stack.md 中包含架构约束。
  2. 全部文档化：文档即设计。“若文档尚不存在，则设计尚不存在。”六份 Royce 规范文档均须规划。
  3. 做两次：先构建试点/原型，交付版本应为第二版；试点计划应存在于 01-strategic-vision/。
  4. 尽早规划测试：测试规划从程序设计阶段开始，而非测试阶段；测试策略应在阶段 03 设计期间启动。
  5. 让客户参与：三道正式评审门：PSR（初步设计后）、CSR（设计期间）、FSAR（测试后）；评审门日期须在项目排期中。

Royce 六份规范文档（交付时均须存在）：软件需求 → SRS_Draft.docx（本流水线）；初步设计规范 → HLD.docx（阶段 03）；接口设计规范 → APISpec.docx + DatabaseDesign.docx（阶段 03）；最终设计规范（竣工）→ 编码后更新的 LLD.docx（阶段 03/04）；测试计划与测试结果 → TestPlan.docx + TestReport.docx（阶段 05）；操作说明 → UserManual.docx + DeploymentGuide.docx（阶段 06/08）。

参考

技能编写与发布标准；最终需求质量门：此处置的每个 SRS 在评审或构建前必须通过的出口门。