SuperAPI AI 工具集

ln-111-root-docs-creator

写作与研究

查看项目

更新于 10-15 16:11

技能介绍

一、用途 ln-111-root-docs-creator 是一个 L3 Worker,负责创建 7 个根级文档文件,作为 AI 智能体的入口点。它属于项目文档初始化流程,上游由 ln-110-project-docs-coordinator 协调器驱动,自身不收集上下文,只消费协调器传入的 Context Store。

二、主要能力

  1. 创建根文档:AGENTS.md、CLAUDE.md、docs/README.md、docs/documentation_standards.md、docs/principles.md。
  2. 基于 templates 模板生成内容,并用 Context Store 中的项目数据替换 {{PLACEHOLDER}} 占位符。
  3. 支持可选工作流原则:当 ENABLE_WORKFLOW_PRINCIPLES=true 时,将 AGENTS.md 中的 {{WORKFLOW_PRINCIPLES_BLOCK}} 占位符替换为 references/templates/agents_md_workflow_principles.md 的完整内容;否则删除该占位符行及其前导注释。
  4. 自校验:对每个文档检查 SCOPE 标签、元数据标记(DOC_KIND、DOC_ROLE、READ_WHEN、SKIP_WHEN、PRIMARY_SOURCES)、必需章节、文档质量契约合规、POSIX 结尾,并尽可能自动修复。
  5. 返回状态:向协调器返回 created_files、skipped_files、quality_inputs(含各文档 owner=ln-111-root-docs-creator)与 validation_status。

三、使用方式 该技能在项目文档初始化流程中被调用。输入来自协调器的 Context Store,包含 PROJECT_NAME、PROJECT_DESCRIPTION、TECH_STACK_SUMMARY、DEV_COMMANDS(来自 package.json scripts)、DATE 等键,以及可选的 ENABLE_WORKFLOW_PRINCIPLES(默认 false)和 targetDir。工作流程分四个阶段:接收上下文并校验必需键;逐个创建文档(存在即跳过,否则复制模板并替换占位符);对每个文档自校验;返回状态。文档也可通过可选 summaryArtifactPath 输出运行时摘要工件(kind 为 docs-generation)。

四、适用场景 适用于项目初始阶段的根级文档设置,为 AI 智能体建立入口文档与标准规范。

五、限制与规则

  1. 幂等:绝不覆盖已有文件,存在则跳过并记录。
  2. 不收集上下文:所有数据来自协调器的 Context Store。
  3. 可发布输出:根文档不得包含 [TBD: ...]、TODO 或泄漏的模板元数据;数据缺失时省略声明或使用简洁中性回退。
  4. 语言:所有根文档使用英文。
  5. 根入口规则:AGENTS.md 是唯一权威内容源;CLAUDE.md 是 Claude Code 专用 stub,包含 @AGENTS.md 导入及 ≤20 行(绝对上限 ≤50 行)的 harness 差异,不重复 AGENTS.md 内容。
  6. NO_CODE_EXAMPLES 规则:根文档仅定义导航与标准,禁止代码块与实现片段,允许表格、链接、单行命令示例。
  7. Stack Adaptation 规则:所有外部链接必须匹配项目技术栈,不得混用。
  8. 格式优先级:表格/ASCII > 列表(仅枚举)> 文本。
  9. 所有占位符必须替换,不得留下模板标记。

六、参考资料 模板文件位于 references/templates/ 下(agents_md_template.md、claude_md_template.md、agents_md_workflow_principles.md、docs_root_readme_template.md、documentation_standards_template.md、principles_template.md);问题清单 references/questions_root.md(Q1-Q22);写作指南 references/agent_instructions_writing_guide.md;环境状态契约 references/environment_state_contract.md。版本 2.1.0,最后更新 2025-01-12。