SuperAPI AI 工具集

doc-iplan

编程与开发

查看项目

更新于 10-16 05:46

技能介绍

用途:doc-iplan 用于创建实现计划(IPLAN),即 SDD 流程第 8 层(最后一个文档层,下游为代码)。IPLAN 把 SPEC 与 TDD 桥接到源代码,声明测试优先的文件顺序(继承自 TDD)、可执行 bash 命令、面向无状态执行器的会话进度,以及从规格到交付文件的审计轨迹。每个 SPEC 组件对应一个 IPLAN(与其 TDD 匹配);无新功能的缺陷修复使用 docs/08_IPLAN/tmp/ 下的临时计划。

使用条件:第 1–7 层已存在,且源 TDD 达到 IPLAN-Ready ≥ 90/100;准备把 SPEC/TDD 组件桥接到源代码;需要可执行、可恢复会话的计划。端到端生成请用 ../doc-iplan-autopilot/SKILL.md。

前置阅读:模板 ${CLAUDE_PLUGIN_ROOT}/framework/layers/08_IPLAN/IPLAN-TEMPLATE.yaml、索引模板 IPLAN-00_index.TEMPLATE.yaml、层 README、ID_NAMING_STANDARDS.md、AUTHORING_STYLE.md,并读取上游 TDD 与 SPEC。只引用存在的文档,不得编造 IPLAN-XXX 或 TBD 占位符;用 ls docs/08_IPLAN/ 2>/dev/null 确认无 ID 冲突。

永久与临时:永久 IPLAN(IPLAN-NN_{slug}.yaml)实现 SPEC 组件、需要 TDD、登记索引、保留审计轨迹、永不删除(用 ABANDONED);临时 IPLAN(tmp/TMP-IPLAN-*.yaml)用于缺陷修复、独立、不登记、DONE/ABANDONED 后 7 天内删除。

结构:YAML 文档,含 metadata(document_type: iplan-document, layer: 8)。按 document_control.subtype 决定必需章节:code_build 为第 1–6 节(document_control、file_manifest、execution_commands、implementation_contracts、session_handoff、traceability);deploy 为第 1、7–11 节(document_control、rollback_procedure、smoke_tests、canary_metrics、observability_hooks、runbook_reference)加 traceability;combined(默认)为全部 11 节。

会话交接:每个无状态会话读取 sessions 最后状态,找到下一个 NOT_STARTED/PARTIAL 文件,续做而不重生成已完成工作,更新状态并追加带 next_session_directive 的会话。标记:NOT_STARTED | IN_PROGRESS | DONE | PARTIAL。草稿阶段 sessions: []。

ID 与标签:文档级 IPLAN-NN(如 @iplan: IPLAN-01),无点分层级元素 ID,禁止 IPLAN.NN.SS.xxxx。必需上游标签 @spec @tdd;层级上游用点号形式,文档级用短横形式;不要输出 @brd:/@prd:/@ears:/@bdd:/@adr:。已移除模式:TASK-XXX、TODO-XXX、TI-XXX、ITEM-XXX。

创建流程:确定类型、预留 ID(本层下一个空闲编号,跨层独立)、创建文件、选择 subtype、先写 Document Control、按 subtype 完成必需章节、声明测试优先文件清单(状态 NOT_STARTED)、写执行命令、定义实现契约(3+ 文件共享接口时,否则写 "No implementation contracts")、留空会话交接并以 planned 条目初始化 code_inventory、登记索引(仅永久)、校验并一起提交。

校验:本技能即校验器(无运行时代码)。检查 layer: 8、document_type、Document Control 完整、6 节非空、文件清单测试在前且含状态与 verified、执行命令覆盖 setup/implementation/validation、实现契约已声明、会话交接存在、上游标签引用存在文档、code_inventory 已播种 planned、永久计划已登记。错误码:XDOC-006 标签格式无效、XDOC-008 内部链接断裂、XDOC-009 缺少 traceability 章节。质量门禁(阻断):CODE-Ready ≥ 90/100 且 0 个 Tier-1 错误。

限制:资料未提供具体收费、价格、平台或效果信息;本技能为文档校验与生成流程,不包含运行时执行代码。