用途 该技能属于 L3 Worker,专门用于创建 DevOps 文档。它的目标是:无条件生成 infrastructure.md(声明式清单:WHAT is deployed WHERE,即部署了什么、部署在哪里),并在满足 Docker 条件时生成 runbook.md(过程性指南:HOW to deploy/restart/troubleshoot,即如何部署、重启和排查问题)。它适用于任何项目中的 DevOps 文档编写。
主要能力
- infrastructure.md(始终创建):填充服务器清单(Server Inventory)、端口分配(Port Allocation)、已部署服务(Deployed Services)、CI/CD 流水线等内容;支持条件裁剪,如未检测到 CI/CD 或工件仓库时使用简洁的空状态说明,单服务器时简化为单列表格,无 GPU 时移除 GPU 列。
- runbook.md(仅当 hasDocker 为 true 时创建):填充本地开发环境搭建步骤、部署、故障排查等内容,包含 .env.example 中的环境变量;支持条件裁剪,如非 multi/auto-scaling 规模时移除扩缩容/负载均衡章节,无 GPU 时移除 GPU 相关章节,服务不在 DOCKER_SERVICES 中时移除对应示例,DEVOPS_CONTACTS 为空时给出空状态说明。
- 自动发现:数据大量来自 docker-compose.yml、.env.example、package.json、SSH config 等(如 DOCKER_COMPOSE_DEV、DOCKER_COMPOSE_PROD、ENV_VARIABLES、STARTUP_SEQUENCE、DEPLOYMENT_TARGET、CI_CD_PIPELINE、DOCKER_SERVICES、DEPLOYMENT_SCALE、DEVOPS_CONTACTS、HAS_GPU、SERVER_INVENTORY、DOMAIN_DNS、ARTIFACT_REPOSITORY、HOST_REQUIREMENTS)。
- 幂等性:若目标文件已存在,则跳过该文件,绝不覆盖已有文件。
- 自校验(Phase 3):检查 SCOPE 标签与元数据标记、必需的顶部章节(Quick Navigation、Agent Entry、Maintenance)、关键章节内容,并检查无过程性内容泄漏(过程性内容应属于 runbook.md)、符合 docs-quality 契约(无禁止占位符、无泄漏的模板元数据、文档类型/角色有效)。
- 返回状态:输出包含 created_files、skipped_files、quality_inputs(doc_paths 与 owners)以及 validation_status 的结构化结果。
- 运行时摘要工件:支持可选的 summaryArtifactPath,摘要 kind 为 docs-generation,负载语义包含 worker = "ln-115"、status、created_files、skipped_files、quality_inputs、validation_status、warnings。
使用方式
- 调用方:由 ln-110-project-docs-coordinator 调用,且始终调用(因为 infrastructure.md 是无条件的);不供用户直接调用。
- 输入:来自协调器的 contextStore(含上述 DevOps 专用数据)、targetDir(项目根目录)、flags(如 hasDocker)。
- 强制阅读:references/docs_quality_contract.md 与 references/markdown_read_protocol.md;可选加载 references/docs_quality_rules.json(仅在需要确切规则 ID、路径矩阵或允许的占位符例外时)。
- 工作流程:Phase 1 检查条件(解析 flags,infrastructure.md 无条件执行,runbook.md 仅当 hasDocker=true,已存在则跳过)→ Phase 2a 创建 infrastructure.md → Phase 2b 创建 runbook.md → Phase 3 自校验 → Phase 4 返回状态。
- 模板与问题:references/templates/infrastructure_template.md、references/templates/runbook_template.md;问题位于 references/questions_devops.md(Q46-Q51 对应 runbook,Q52-Q55 对应 infrastructure)。
- 路径说明:references/、../ln-* 等路径相对于该技能目录。
适用场景
- 任何项目需要生成 DevOps 基础设施清单文档。
- 使用 Docker 的项目需要生成部署/重启/排查运行手册。
- 作为项目文档生成流程中的一环,由协调器统一调度。
限制
- runbook.md 仅在 hasDocker=true 时创建;不满足条件时完全跳过。
- 不自行收集上下文,只能使用协调器传入的 Context Store 数据。
- 幂等设计:不会覆盖已存在的文件。
- 发布要求:输出中不得留有 [TBD: ...]、TODO 或泄漏的模板元数据;缺失数据时应省略该声明或使用简洁中性的回退表述。
- NO_CODE_EXAMPLES 规则(强制):两份文档描述清单/流程,而非实现;禁止完整 Docker 配置、CI/CD 流水线(超过 5 行)、完整 nginx 配置;允许命令示例(1-3 行)、环境变量表、步骤列表、验证命令;需要代码时改为“See docker-compose.yml”。
- Stack Adaptation 规则(强制):命令必须匹配项目技术栈(npm/pip/go),链接到正确的云厂商文档(AWS/Azure/GCP),不得混用技术栈引用。
- Format Priority 规则(强制):表格(环境变量、端口、服务、服务器)> 列表(搭建步骤)> 文本。
- 版本为 2.0.0,最后更新于 2025-01-12。
- 关于收费、价格、平台支持范围等事实暂未提供。