SuperAPI AI 工具集

ln-120-reference-docs-creator

写作与研究

查看项目

更新于 10-16 09:21

技能介绍

用途

该技能用于创建参考文档结构(docs/reference/)以及智能文档(ADR、指南、手册),依据项目的 TECH_STACK 生成。文档仅在“有正当理由”(即存在替代方案的非平凡技术选择)时才创建。

它属于 L2 Worker,由 ln-100-documents-pipeline 编排器调用。也可在仅需创建参考文档结构(docs/reference/)、为 ADR、指南和手册搭建目录时直接使用;若需完整文档结构,应使用 ln-100-documents-pipeline。

主要能力

  • 创建参考文档目录结构:docs/reference/ 下的 adrs/、guides/、manuals/、research/ 四个子目录,以及 README 索引中心。
  • 智能文档创建:根据 TECH_STACK 判断各技术类别是否“有正当理由”,为符合条件的类别生成 ADR、指南和手册,跳过平凡选择。
  • 结构校验:检查 README 的开头契约(SCOPE 标签)、必需章节、Maintenance 章节和 POSIX 文件结尾,并自动修复违规。
  • 内容校验:按问题驱动方式校验各章节内容,并通过自动发现已有文件填充索引列表。

使用方式

该技能遵循四阶段工作流:CREATE STRUCTURE → SMART DOCUMENT CREATION → VALIDATE STRUCTURE → VALIDATE CONTENT。

输入来自 ln-100(经由 ln-110 Context Store),包含 PROJECT_NAME、TECH_STACK、DEPENDENCIES 和 flags 等字段。TECH_STACK 用于第二阶段智能文档创建。

强制读取:references/docs_quality_contract.md 和 references/markdown_read_protocol.md。可选规则目录 references/docs_quality_rules.json 仅在需要精确规则 ID、路径矩阵或允许的占位符例外时加载。

第一阶段创建目录与 README(若已存在则跳过),README 由模板生成并替换 VERSION、DATE 及各列表占位符。

第二阶段依据 references/tech_justification_rules.md 判断各技术类别是否值得记录。例如 frontend、backend、database、orm、auth、cache 等类别在存在多个可选方案时视为有正当理由;而仅用 jQuery 的前端、简单 http 服务器、仅开发用的 SQLite、无需认证、仅用原生 SQL、仅内存缓存等则视为平凡选择而跳过。符合条件的类别会生成 ADR(使用 Nygard 格式模板)、指南(模式文档,Do/Don't/When)或手册(API 参考格式),并可能调用 MCP 研究工具(如 mcp__context7__resolve-library-id、mcp__Ref__ref_search_documentation)。

第三阶段校验 README 结构并自动修复:补充 SCOPE 标签、缺失章节、Maintenance 章节和 POSIX 结尾。

第四阶段按参数化循环校验四个章节(ADR、指南、手册、研究)的内容,若内容无效或为空状态,则用 Glob 扫描对应目录,发现文件后生成动态列表替换空状态文本;无文件则保留简洁空状态说明。

适用场景

  • 项目需要为架构决策提供有依据的决策记录(ADR)。
  • 需要为复杂配置或自定义模式的技术编写项目指南。
  • 需要为复杂外部 API 的包编写手册。
  • 仅需搭建参考文档目录结构。

限制与规则

  • 仅为有正当理由的非平凡技术选择创建文档,平凡/显而易见的选择会被跳过。
  • 指南遵循 NO_CODE_EXAMPLES 规则:禁止完整函数实现和超过 5 行的代码块;允许 Do/Don't/When 表格、单行方法签名、1-3 行伪代码;应改为引用源码位置。
  • 技术栈适配:ADR 的替代方案必须与栈匹配(如 React 对比 Vue,而非 React 对比 Django);指南链接须指向对应平台文档。
  • 格式优先级:表格(Do/Don't/When)> ASCII 图 > 列表 > 文本。
  • 幂等:创建前检查存在性,可安全多次运行。
  • 前置条件:需要 docs/ 目录(由 ln-111-root-docs-creator 创建或目标项目中已存在)。
  • 运行时会生成 docs-generation 类型的摘要工件,包含 worker、status、created_files、skipped_files、quality_inputs、validation_status、warnings 等字段。

输出结构

docs/reference/ 下包含 README.md(带索引的参考中心)、adrs/、guides/、manuals/、research/ 四个目录(可能为空或含文件)。