ln-100-documents-pipeline by levnikolaevich/claude-code-skills
npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-100-documents-pipelinePaths: File paths (
shared/,references/,../ln-*) are relative to skills repo root. If not found at CWD, locate this SKILL.md directory and go up one level for repo root. Ifshared/is missing, fetch files via WebFetch fromhttps://raw.githubusercontent.com/levnikolaevich/claude-code-skills/master/skills/{path}.
Type: L1 Top Orchestrator Category: 1XX Documentation Pipeline
此技能通过调用 L2 协调器和 4 个 L2 工作器,编排创建完整的文档系统。协调器 (ln-110) 将项目文档任务委托给 5 个 L3 工作器;其他 L2 工作器处理参考/任务/测试领域。每个组件都会验证自己的输出。
顶级编排器,通过一次调用创建完整的项目文档系统。按顺序链式调用 ln-110 协调器 + ln-120/130/140 工作器,然后运行全局清理(去重、孤立文件报告、交叉链接验证)。
ln-100-documents-pipeline (L1 Top Orchestrator - this skill)
├── ln-110-project-docs-coordinator (L2 Coordinator)
│ ├── ln-111-root-docs-creator (L3 Worker) → 4 docs
│ ├── ln-112-project-core-creator (L3 Worker) → 3 docs
│ ├── ln-113-backend-docs-creator (L3 Worker) → 2 conditional
│ ├── ln-114-frontend-docs-creator (L3 Worker) → 1 conditional
│ └── ln-115-devops-docs-creator (L3 Worker) → 1 conditional
├── ln-120-reference-docs-creator (L2 Worker)
├── ln-130-tasks-docs-creator (L2 Worker)
├── ln-140-test-docs-creator (L2 Worker - optional)
└── ln-610-docs-auditor (L2 Coordinator - optional, delegates to ln-611/612/613/614)
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
在以下情况下应使用此技能:
替代方案:如果您偏好精细控制,可以手动调用工作器:
注意:每个工作器现在都会在第 2/3 阶段验证自己的输出。编排器仅处理全局操作。
该技能遵循一个 6 阶段的编排工作流:遗留迁移(可选) → 用户确认 → 按顺序调用协调器 + 4 个工作器 → 全局清理 → 文档审计(可选) → 总结。
目标:检测非标准格式的现有文档,提取有价值的内容,并准备迁移。
触发条件:始终在流水线开始时运行。如果没有遗留文档或希望保留现有结构,用户可以跳过。
流程:
0a. 遗留文档检测:
references/legacy_detection_patterns.md 中的模式扫描项目中的非标准文档:
ARCHITECTURE.md、REQUIREMENTS.md、STACK.md、API.md、DATABASE.md、DEPLOYMENT.mddocumentation/、doc/、wiki/、docs/## Architecture、## Tech Stack、## Requirements 等## Development、## Code Style、## Coding Standardslegacy_manifest:包含 { path, detected_type, target_doc, confidence } 的列表0b. 内容提取:
references/legacy_detection_patterns.md):
architecture_extractor → { layers[], components[], diagrams[] }requirements_extractor → { functional[], non_functional[] }tech_stack_extractor → { frontend, backend, database, versions }principles_extractor → { principles[], anti_patterns[] }api_spec_extractor → { endpoints[], authentication }database_schema_extractor → { tables[], relationships[] }runbook_extractor → { prerequisites[], install_steps[], env_vars[] }infrastructure_extractor → { servers[], domains[], ports[], services[], artifacts{}, cicd{} }extracted_content 对象中0c. 用户确认:
显示检测到的遗留文件:
📂 检测到遗留文档:
| 文件 | 类型 | 置信度 | 目标 |
|------|------|------------|--------|
| README.md (## Architecture) | 架构 | 高 | docs/project/architecture.md |
| docs/ARCHITECTURE.md | 架构 | 高 | docs/project/architecture.md |
| CONTRIBUTING.md (## Development) | 原则 | 中 | docs/principles.md |
🔄 迁移选项:
1. 迁移(推荐):提取 → 注入 → 归档 → 删除
2. 仅归档:备份但不提取内容
3. 跳过:保持遗留文件原样(可能导致重复)
选择选项 (1/2/3): _
如果用户选择 "1"(迁移):
如果用户选择 "2"(仅归档):
如果用户选择 "3"(跳过):
0d. 备份和归档:
创建 .archive/legacy-{timestamp}/ 目录
结构:
.archive/
└── legacy-YYYY-MM-DD-HHMMSS/
├── README_migration.md # 回滚说明
├── original/ # 遗留文件的精确副本
│ ├── README.md
│ ├── ARCHITECTURE.md
│ └── documentation/
└── extracted/ # 提取的内容(供参考)
├── architecture_content.md
└── principles_content.md
将所有遗留文件复制到 original/
将提取的内容保存到 extracted/
生成包含回滚说明的 README_migration.md
0e. 内容注入:
根据提取的内容构建 migration_context:
{
"LEGACY_CONTENT": {
"legacy_architecture": { "sections": [...], "diagrams": [...] },
"legacy_requirements": { "functional": [...] },
"legacy_principles": { "principles": [...] },
"legacy_tech_stack": { "frontend": "...", "backend": "..." },
"legacy_api": { "endpoints": [...] },
"legacy_database": { "tables": [...] },
"legacy_runbook": { "install_steps": [...] },
"legacy_infrastructure": { "servers": [...], "domains": [...], "ports": {} }
}
}
合并到 ln-110 的上下文存储中:
contextStore.LEGACY_CONTENT = migration_context优先级顺序:遗留内容 > 自动发现 > 模板默认值
0f. 清理(遗留文件):
## Architecture → 参见 [架构](docs/project/architecture.md)## Tech Stack → 参见 [技术栈](docs/project/tech_stack.md)输出:migration_summary { migrated_count, archived_count, skipped_count, legacy_content }
目标:检查现有文件,解释工作流,并获得用户批准。
流程:
迁移总结(如果运行了阶段 0):
飞行前检查(扫描现有文档):
使用 Glob 工具检查所有潜在文件:
CLAUDE.md、docs/README.md、docs/documentation_standards.md、docs/principles.mddocs/reference/README.md、docs/reference/adrs/、docs/reference/guides/、docs/reference/manuals/、docs/reference/research/docs/tasks/README.md、docs/tasks/kanban_board.mddocs/project/requirements.md、architecture.md、tech_stack.md、api_spec.md、database_schema.md、design_guidelines.md、infrastructure.md、runbook.mddocs/reference/guides/testing-strategy.md、tests/README.md统计现有文件与缺失文件的数量
向用户显示总结:
📊 文档状态:
✓ 已找到:X 个现有文件
✗ 缺失:Y 个文件
⚠️ 流水线将仅创建缺失的文件。
✅ 现有文件将被保留(不会覆盖)。
向用户展示将要创建的内容:
询问:"继续创建缺失的文件吗?(yes/no)"
询问:"包含测试文档 (tests/README.md) 吗?(yes/no)"
输出:文件扫描总结 + 用户批准 + 测试文档偏好
目标:通过按顺序调用 L2 协调器和 4 个 L2 工作器来创建完整的文档系统。
流程(使用技能工具自动调用):
2a. 创建根目录 + 项目文档:
Skill(skill: "ln-110-project-docs-coordinator") → 自动LEGACY_CONTENT(如果执行了迁移)CLAUDE.md + docs/README.md + docs/documentation_standards.md + docs/principles.md) + 项目文档 (docs/project/requirements.md、architecture.md、tech_stack.md、infrastructure.md + 条件性:api_spec.md、database_schema.md、design_guidelines.md、runbook.md)context_store(包含用于 ln-120 的 TECH_STACK)2b. 创建参考文档结构 + 智能文档:
Skill(skill: "ln-120-reference-docs-creator") → 自动context_store(TECH_STACK 启用智能文档创建)docs/reference/README.md + adrs/、guides/、manuals/、research/ 目录 + 合理的 ADRs/Guides/Manuals2c. 创建任务管理文档:
Skill(skill: "ln-130-tasks-docs-creator") → 自动docs/tasks/README.md + 可选地 kanban_board.md(如果用户提供 Linear 配置)2d. 创建测试文档(可选):
Skill(skill: "ln-140-test-docs-creator") → 自动tests/README.md(包含故事级测试任务模式的测试文档)2f. 从文档中提取技能(可选):
Skill(skill: "ln-160-docs-skill-extractor") → 自动.claude/commands/*.md 文件输出:完整的文档系统,协调器和 4 个工作器已完成并验证
TodoWrite 格式(必填):在开始前将所有调用添加到待办事项中:
- Invoke ln-110-project-docs-coordinator (pending)
- Invoke ln-120-reference-docs-creator (pending)
- Invoke ln-130-tasks-docs-creator (pending)
- Invoke ln-140-test-docs-creator (pending)
- Run Global Cleanup (Phase 3) (pending)
- Run Documentation Audit (Phase 4 - optional) (pending)
当开始时将每个标记为 in_progress,当工作器返回成功时标记为 completed。
目标:删除重复项、孤立文件,整合所有文档中的知识。
触发条件:仅在所有工作器完成第 2/3 阶段验证后。
流程:
3a. 文档质量检查
对每个创建的文档进行快速质量检查:
---|---|---|---
1 | 完整性 | 所有模板章节已填写(没有剩余的 TODOs) | 空章节或占位符文本
2 | 准确性 | 技术栈与实际项目文件匹配 | 引用了不存在的框架
3 | 时效性 | 日期和版本与当前状态匹配 | 过时的引用
关卡:所有失败项 → 在继续清理前内联修复。在阶段 4 报告质量总结。
3b. 扫描重复内容
读取 docs/ 中的所有 .md 文件
pattern: "docs/**/*.md"识别重复章节:
如果 2 个或更多章节具有:
80% 的内容相似度(简单的单词重叠检查)
标记为重复
确定规范版本:
移除重复项:
对于每个重复章节:
使用编辑工具从非规范文件中删除
使用编辑工具添加指向规范位置的链接:
有关详细信息,请参见 [开发原则](../principles.md#development-principles)。
跟踪已移除的重复项数量
记录结果:
3c. 报告意外文件(建议性)
列出 docs/ 中的所有 .md 文件
pattern: "docs/**/*.md"对照预期结构检查(由工作器创建的文件 + 用户创建的参考文档)
报告发现(请勿移动/删除/归档):
3d. 整合知识
识别分散的信息:
对于每个分散的概念:
更新非 SSoT 文件:
使用编辑工具将重复内容替换为链接:
有关团队 ID 和设置,请参见 [Linear 配置](../tasks/kanban_board.md#linear-configuration)。
跟踪整合数量
记录结果:
3e. 交叉链接验证
扫描所有 .md 文件中的内部链接:
[text](path)验证链接目标是否存在:
修复损坏的链接:
添加缺失的关键链接:
记录结果:
3f. 最终报告
✅ 全局清理完成:
结构:
- 已移除 {N} 个重复章节(规范版本:principles.md)
- 发现 {N} 个意外文件(已列出供用户审阅)
- 已整合 {N} 个分散的概念
链接:
- 已修复 {N} 个损坏的链接
- 已添加 {N} 个缺失的关键链接:
- 添加的链接列表
输出:所有文档已清理,重复项已移除,意外文件已报告,知识已整合,交叉链接已验证
目标:审计文档和代码注释的质量。
触发条件:仅当用户请求审计或流水线使用审计标志调用时。
流程:
4a. 询问用户:
文档审计选项:
1. 审计文档:运行 ln-610-docs-auditor(结构 + 语义 + 注释)
2. 跳过:继续到总结
选择选项 (1/2): _
4b. 运行选定的审计器:
Skill(skill: "ln-610-docs-auditor") → 自动4c. 显示审计总结:
📊 审计结果:
- 文档质量:总体 X/10
- 层次结构 & 链接:X/10
- 单一事实来源:X/10
- ...
- 代码注释质量:总体 X/10
- 解释原因而非描述内容:X/10
- 密度 (15-20%):X/10
- ...
有关详细发现,请参见上面的完整报告。
输出:包含合规性分数和发现结果的审计报告
目标:提供所创建系统的完整概览。
流程:
列出所有创建的文件及其大小:
CLAUDE.md(项目入口点)docs/README.md(根文档中心)docs/documentation_standards.md(60 条通用要求)docs/principles.md(11 条开发原则)docs/project/requirements.md、architecture.md、tech_stack.md + 条件性文档(总共 3-7 个文件)docs/reference/README.md(参考文档中心,包含空的 adrs/、guides/、manuals/、research/ 目录)docs/tasks/README.md + 可选地 kanban_board.mdtests/README.md(如果已创建)展示文档系统特性:
推荐后续步骤:
输出:包含文件列表和建议的总结消息
project_root/
├── CLAUDE.md # ← 项目入口点(链接到 docs/)
├── docs/
│ ├── README.md # ← 根文档中心(通用标准)
│ ├── documentation_standards.md # ← 60 条通用要求(Claude Code + 行业标准)
│ ├── principles.md # ← 11 条开发原则(标准优先、YAGNI、KISS、DRY 等)
│ ├── project/
│ │ ├── requirements.md # ← 功能需求(根据项目策略,不包含非功能需求)
│ │ ├── architecture.md # ← 基于 arc42 的架构,包含 C4 模型
│ │ ├── tech_stack.md # ← 技术版本、Docker 配置
│ │ ├── api_spec.md # ← API 端点(条件性)
│ │ ├── database_schema.md # ← 数据库模式(条件性)
│ │ ├── design_guidelines.md # ← UI/UX 系统(条件性)
│ │ ├── infrastructure.md # ← 基础设施清单(始终创建)
│ │ └── runbook.md # ← 运维指南(条件性)
│ ├── reference/
│ │ ├── README.md # ← 参考文档中心(注册表)
│ │ ├── adrs/ # ← 空,准备存放 ADRs
│ │ ├── guides/ # ← 空,准备存放指南
│ │ ├── manuals/ # ← 空,准备存放手册
│ │ └── research/ # ← 空,准备存放研究
│ ├── tasks/
│ │ ├── README.md # ← 任务管理系统规则
│ │ └── kanban_board.md # ← Linear 集成(可选)
└── tests/
└── README.md # ← 测试文档(可选)
新项目的推荐工作流:
权衡:
何时改用手动方法:
此流水线创建的所有文档必须遵循以下规则:
| 规则 | 描述 | 执行 |
|---|---|---|
| NO_CODE 规则 | 文档描述契约,而非实现 | 代码块不超过 5 行;使用表格/ASCII/链接 |
| 技术栈适配 | 链接必须与项目 TECH_STACK 匹配 | .NET → Microsoft 文档,JS → MDN |
| 格式优先级 | 表格/ASCII > 列表(仅用于枚举)> 文本 | 参数、配置、备选方案使用表格 |
这些标准由 L3 工作器 (ln-111-115) 强制执行,并由 ln-610-docs-auditor 审计。
如果任何调用的技能失败:
技能调用:
文件验证:
全局清理:
标准合规性:
必读:加载 shared/references/meta_analysis_protocol.md
技能类型:planning-coordinator。在所有阶段完成后运行。使用 planning-coordinator 格式输出到聊天。
references/legacy_detection_patterns.mdln-110-project-docs-coordinator、ln-120-reference-docs-creator、ln-130-tasks-docs-creator、ln-140-test-docs-creatorln-610-docs-auditor(协调 ln-611/612/613/614)在完成工作前,验证所有检查点:
✅ 遗留迁移(阶段 0 - 如果适用):
.archive/legacy-{timestamp}/original/.archive/legacy-{timestamp}/extracted/✅ 用户确认(阶段 1):
✅ 已按顺序调用协调器和工作器(阶段 2):
CLAUDE.md + docs/README.md + docs/documentation_standards.md + docs/principles.md) + 项目文档 (docs/project/requirements.md、architecture.md、`tech_stack.mdPaths: File paths (
shared/,references/,../ln-*) are relative to skills repo root. If not found at CWD, locate this SKILL.md directory and go up one level for repo root. Ifshared/is missing, fetch files via WebFetch fromhttps://raw.githubusercontent.com/levnikolaevich/claude-code-skills/master/skills/{path}.
Type: L1 Top Orchestrator Category: 1XX Documentation Pipeline
This skill orchestrates the creation of a complete documentation system by invoking L2 coordinator + 4 L2 workers. The coordinator (ln-110) delegates to 5 L3 workers for project docs; other L2 workers handle reference/tasks/test domains. Each component validates its own output.
Top-level orchestrator that creates a complete project documentation system in one invocation. Chains ln-110 coordinator + ln-120/130/140 workers sequentially, then runs global cleanup (deduplication, orphan reporting, cross-link validation).
ln-100-documents-pipeline (L1 Top Orchestrator - this skill)
├── ln-110-project-docs-coordinator (L2 Coordinator)
│ ├── ln-111-root-docs-creator (L3 Worker) → 4 docs
│ ├── ln-112-project-core-creator (L3 Worker) → 3 docs
│ ├── ln-113-backend-docs-creator (L3 Worker) → 2 conditional
│ ├── ln-114-frontend-docs-creator (L3 Worker) → 1 conditional
│ └── ln-115-devops-docs-creator (L3 Worker) → 1 conditional
├── ln-120-reference-docs-creator (L2 Worker)
├── ln-130-tasks-docs-creator (L2 Worker)
├── ln-140-test-docs-creator (L2 Worker - optional)
└── ln-610-docs-auditor (L2 Coordinator - optional, delegates to ln-611/612/613/614)
This skill should be used when:
Alternative : If you prefer granular control, invoke workers manually:
Note : Each worker now validates its own output in Phase 2/3. Orchestrator handles global operations only.
The skill follows a 6-phase orchestration workflow: Legacy Migration (optional) → User confirmation → Invoke coordinator + 4 workers sequentially → Global cleanup → Documentation Audit (optional) → Summary.
Objective : Detect existing documentation in non-standard formats, extract valuable content, and prepare for migration.
Trigger : Always runs at pipeline start. User can skip if no legacy docs or wants to keep existing structure.
Process :
0a. Legacy Detection :
references/legacy_detection_patterns.md:
ARCHITECTURE.md, REQUIREMENTS.md, STACK.md, API.md, DATABASE.md, DEPLOYMENT.mddocumentation/, doc/, wiki/, with wrong structure0b. Content Extraction :
references/legacy_detection_patterns.md):
architecture_extractor → { layers[], components[], diagrams[] }requirements_extractor → { functional[], non_functional[] }tech_stack_extractor → { frontend, backend, database, versions }principles_extractor → { principles[], anti_patterns[] }api_spec_extractor → { endpoints[], authentication }database_schema_extractor → { tables[], relationships[] }runbook_extractor → { prerequisites[], install_steps[], env_vars[] }0c. User Confirmation :
Display detected legacy files:
📂 Legacy Documentation Detected:
| File | Type | Confidence | Target |
|------|------|------------|--------|
| README.md (## Architecture) | architecture | HIGH | docs/project/architecture.md |
| docs/ARCHITECTURE.md | architecture | HIGH | docs/project/architecture.md |
| CONTRIBUTING.md (## Development) | principles | MEDIUM | docs/principles.md |
🔄 Migration Options:
1. MIGRATE (recommended): Extract → Inject → Archive → Delete
2. ARCHIVE ONLY: Backup without extraction
3. SKIP: Leave legacy as-is (may cause duplication)
Choose option (1/2/3): _
If user selects "1" (MIGRATE):
If user selects "2" (ARCHIVE ONLY):
If user selects "3" (SKIP):
0d. Backup and Archive :
Create .archive/legacy-{timestamp}/ directory
Structure:
.archive/
└── legacy-YYYY-MM-DD-HHMMSS/
├── README_migration.md # Rollback instructions
├── original/ # Exact copies of legacy files
│ ├── README.md
│ ├── ARCHITECTURE.md
│ └── documentation/
└── extracted/ # Extracted content (for reference)
├── architecture_content.md
└── principles_content.md
Copy all legacy files to original/
Save extracted content to extracted/
Generate README_migration.md with rollback instructions
0e. Content Injection :
Build migration_context from extracted content:
{
"LEGACY_CONTENT": {
"legacy_architecture": { "sections": [...], "diagrams": [...] },
"legacy_requirements": { "functional": [...] },
"legacy_principles": { "principles": [...] },
"legacy_tech_stack": { "frontend": "...", "backend": "..." },
"legacy_api": { "endpoints": [...] },
"legacy_database": { "tables": [...] },
"legacy_runbook": { "install_steps": [...] },
"legacy_infrastructure": { "servers": [...], "domains": [...], "ports": {} }
}
}
Merge into Context Store for ln-110:
contextStore.LEGACY_CONTENT = migration_contextPriority order: Legacy content > Auto-discovery > Template defaults
0f. Cleanup (Legacy Files) :
## Architecture → See [Architecture](docs/project/architecture.md)## Tech Stack → See [Tech Stack](docs/project/tech_stack.md)Output : migration_summary { migrated_count, archived_count, skipped_count, legacy_content }
Objective : Check existing files, explain workflow, and get user approval.
Process :
Migration Summary (if Phase 0 ran):
Pre-flight Check (scan existing documentation):
Use Glob tool to check all potential files:
CLAUDE.md, docs/README.md, docs/documentation_standards.md, docs/principles.mddocs/reference/README.md, docs/reference/adrs/, docs/reference/guides/, , Output : File scan summary + user approval + test docs preference
Objective : Create complete documentation system by invoking L2 coordinator + 4 L2 workers in order.
Process (AUTOMATIC invocations with Skill tool):
2a. Create Root + Project Documentation :
Skill(skill: "ln-110-project-docs-coordinator") → AUTOMATICLEGACY_CONTENT from Phase 0 (if migration was performed)CLAUDE.md + docs/README.md + docs/documentation_standards.md + docs/principles.md) + Project docs (, , , + conditional: , , , )2b. Create Reference Structure + Smart Documents :
Skill(skill: "ln-120-reference-docs-creator") → AUTOMATICcontext_store from ln-110 (TECH_STACK enables smart document creation)docs/reference/README.md + adrs/, guides/, manuals/, research/ directories + justified ADRs/Guides/Manuals2c. Create Task Management Docs :
Skill(skill: "ln-130-tasks-docs-creator") → AUTOMATICdocs/tasks/README.md + optionally kanban_board.md (if user provides Linear config)2d. Create Test Documentation (Optional) :
Skill(skill: "ln-140-test-docs-creator") → AUTOMATICtests/README.md (test documentation with Story-Level Test Task Pattern)2f. Extract Skills from Documentation (Optional) :
Skill(skill: "ln-160-docs-skill-extractor") → AUTOMATIC.claude/commands/*.md files extracted from procedural documentation sectionsOutput : Complete documentation system with coordinator + 4 workers completed and validated
TodoWrite format (mandatory): Add ALL invocations to todos before starting:
- Invoke ln-110-project-docs-coordinator (pending)
- Invoke ln-120-reference-docs-creator (pending)
- Invoke ln-130-tasks-docs-creator (pending)
- Invoke ln-140-test-docs-creator (pending)
- Run Global Cleanup (Phase 3) (pending)
- Run Documentation Audit (Phase 4 - optional) (pending)
Mark each as in_progress when starting, completed when worker returns success.
Objective : Remove duplicates, orphaned files, consolidate knowledge across ALL documentation.
Trigger : Only after ALL workers complete Phase 2/3 validation.
Process :
3a. Documentation Quality Check
Quick quality check per created document:
---|---|---|---
1 | Completeness | All template sections filled (no TODOs remaining) | Empty sections or placeholder text
2 | Accuracy | Tech stack matches actual project files | References non-existent frameworks
3 | Actuality | Dates and versions match current state | Outdated references
Gate: All FAIL items → fix inline before continuing cleanup. Report quality summary in Phase 4.
3b. Scan for duplicate content
Read all .md files in docs/
pattern: "docs/**/*.md"Identify duplicate sections:
If 2+ sections have:
80% content similarity (simple word overlap check)
Mark as duplicate
Determine canonical version:
Remove duplicates:
3c. Report unexpected files (advisory)
List all .md files in docs/
pattern: "docs/**/*.md"Check against expected structure (files created by workers + user-created reference docs)
Report findings (DO NOT move/delete/archive):
3d. Consolidate knowledge
Identify scattered information:
For each scattered concept:
Update non-SSoT files:
Use Edit tool to replace duplicate content with link:
See [Linear Configuration](../tasks/kanban_board.md#linear-configuration) for team ID and settings.
Track consolidation count
Log results:
3e. Cross-link validation
Scan all .md files for internal links:
[text](path)Verify link targets exist:
Fix broken links:
Add missing critical links:
3f. Final report
✅ Global Cleanup Complete:
Structure:
- Removed {N} duplicate sections (canonical: principles.md)
- Found {N} unexpected files (listed for user review)
- Consolidated {N} scattered concepts
Links:
- Fixed {N} broken links
- Added {N} missing critical links:
- list of added links
Output : All documentation cleaned up, duplicates removed, unexpected files reported, knowledge consolidated, cross-links validated
Objective : Audit documentation and code comments quality.
Trigger : Only if user requests audit OR pipeline invoked with audit flags.
Process :
4a. Ask User :
Documentation Audit Options:
1. AUDIT DOCS: Run ln-610-docs-auditor (structure + semantic + comments)
2. SKIP: Continue to summary
Choose option (1/2): _
4b. Run Selected Auditor :
Skill(skill: "ln-610-docs-auditor") → AUTOMATIC4c. Show Audit Summary :
📊 Audit Results:
- Documentation Quality: X/10 overall
- Hierarchy & Links: X/10
- Single Source of Truth: X/10
- ...
- Code Comments Quality: X/10 overall
- WHY not WHAT: X/10
- Density (15-20%): X/10
- ...
See full reports above for detailed findings.
Output : Audit reports with compliance scores and findings
Objective : Provide complete overview of created system.
Process :
List all created files with sizes:
CLAUDE.md (project entry point)docs/README.md (root documentation hub)docs/documentation_standards.md (60 universal requirements)docs/principles.md (11 development principles)docs/project/requirements.md, architecture.md, tech_stack.md + conditional documents (3-7 total)docs/reference/README.md (reference hub with empty adrs/, guides/, manuals/, research/ directories)docs/tasks/README.md + optionally Output : Summary message with file list and recommendations
project_root/
├── CLAUDE.md # ← Project entry point (link to docs/)
├── docs/
│ ├── README.md # ← Root documentation hub (general standards)
│ ├── documentation_standards.md # ← 60 universal requirements (Claude Code + industry standards)
│ ├── principles.md # ← 11 development principles (Standards First, YAGNI, KISS, DRY, etc.)
│ ├── project/
│ │ ├── requirements.md # ← Functional Requirements (NO NFR per project policy)
│ │ ├── architecture.md # ← arc42-based architecture with C4 Model
│ │ ├── tech_stack.md # ← Technology versions, Docker config
│ │ ├── api_spec.md # ← API endpoints (conditional)
│ │ ├── database_schema.md # ← Database schema (conditional)
│ │ ├── design_guidelines.md # ← UI/UX system (conditional)
│ │ ├── infrastructure.md # ← Infrastructure inventory (always)
│ │ └── runbook.md # ← Operations guide (conditional)
│ ├── reference/
│ │ ├── README.md # ← Reference documentation hub (registries)
│ │ ├── adrs/ # ← Empty, ready for ADRs
│ │ ├── guides/ # ← Empty, ready for guides
│ │ ├── manuals/ # ← Empty, ready for manuals
│ │ └── research/ # ← Empty, ready for research
│ ├── tasks/
│ │ ├── README.md # ← Task management system rules
│ │ └── kanban_board.md # ← Linear integration (optional)
└── tests/
└── README.md # ← Test documentation (optional)
Recommended workflow for new projects:
Trade-offs:
When to use manual approach instead:
All documents created by this pipeline MUST follow these rules:
| Rule | Description | Enforcement |
|---|---|---|
| NO_CODE Rule | Documents describe contracts, not implementations | No code blocks >5 lines; use tables/ASCII/links |
| Stack Adaptation | Links must match project TECH_STACK | .NET → Microsoft docs, JS → MDN |
| Format Priority | Tables/ASCII > Lists (enumerations only) > Text | Tables for params, config, alternatives |
These standards are enforced by L3 workers (ln-111-115) and audited by ln-610-docs-auditor.
If any invoked skill fails:
Skill Invocation:
File Verification:
Global Cleanup:
Standards Compliance:
MANDATORY READ: Load shared/references/meta_analysis_protocol.md
Skill type: planning-coordinator. Run after all phases complete. Output to chat using the planning-coordinator format.
references/legacy_detection_patterns.mdln-110-project-docs-coordinator, ln-120-reference-docs-creator, ln-130-tasks-docs-creator, ln-140-test-docs-creatorln-610-docs-auditor (coordinates ln-611/612/613/614)Before completing work, verify ALL checkpoints:
✅ Legacy Migration (Phase 0 - if applicable):
.archive/legacy-{timestamp}/original/.archive/legacy-{timestamp}/extracted/✅ User Confirmation (Phase 1):
✅ Coordinator + Workers Invoked Sequentially (Phase 2):
CLAUDE.md + docs/README.md + docs/documentation_standards.md + docs/principles.md) + Project docs (docs/project/requirements.md, architecture.md, tech_stack.md + conditional 3-7 files)docs/reference/README.md + directories (adrs/, guides/, manuals/, research/) + justified ADRs/Guides/Manuals based on TECH_STACKdocs/tasks/README.md + optionally kanban_board.md✅ File Verification Complete:
✅ Global Cleanup Complete (Phase 3):
✅ Documentation Audit (Phase 4 - if selected):
✅ Summary Displayed (Phase 5):
✅ Error Handling (if applicable):
Output: Complete documentation system (CLAUDE.md + docs/ with README.md, documentation_standards.md, principles.md + optionally tests/) with global cleanup (no duplicates, orphaned files reported, consolidated knowledge, validated cross-links)
Version: 8.1.0 Last Updated: 2025-01-12
Weekly Installs
153
Repository
GitHub Stars
245
First Seen
Feb 2, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykWarn
Installed on
cursor139
codex139
gemini-cli138
opencode138
claude-code137
github-copilot136
Skills CLI 使用指南:AI Agent 技能包管理器安装与管理教程
33,600 周安装
iOS Vision框架开发指南:计算机视觉、OCR、姿态检测与Visual Intelligence集成
152 周安装
cc-skill-continuous-learning:Claude代码模板持续学习技能,提升开发效率与代码质量
152 周安装
Git提交工作流优化工具 - 遵循Conventional Commits规范,提升代码审查效率
152 周安装
测试自动化框架指南:Playwright与pytest最佳实践,提升测试效率与可维护性
152 周安装
nf-core 流程部署指南:生物信息学分析自动化与Nextflow开发
152 周安装
解决方案架构师技能:复杂销售场景技术需求分析、解决方案设计与集成架构
152 周安装
docs/## Architecture, ## Tech Stack, ## Requirements, etc.## Development, ## Code Style, ## Coding Standardslegacy_manifest: list of { path, detected_type, target_doc, confidence }infrastructure_extractor → { servers[], domains[], ports[], services[], artifacts{}, cicd{} }extracted_content objectdocs/reference/manuals/docs/reference/research/docs/tasks/README.md, docs/tasks/kanban_board.mddocs/project/requirements.md, architecture.md, tech_stack.md, api_spec.md, database_schema.md, design_guidelines.md, infrastructure.md, runbook.mddocs/reference/guides/testing-strategy.md, tests/README.mdCount existing vs missing files
Show user summary:
📊 Documentation Status:
✓ Found: X existing files
✗ Missing: Y files
⚠️ Pipeline will create ONLY missing files.
✅ Existing files will be preserved (no overwrites).
Show user what will be created:
Ask: "Proceed with creating missing files? (yes/no)"
Ask: "Include test documentation (tests/README.md)? (yes/no)"
docs/project/requirements.mdarchitecture.mdtech_stack.mdinfrastructure.mdapi_spec.mddatabase_schema.mddesign_guidelines.mdrunbook.mdcontext_store from ln-110 result (contains TECH_STACK for ln-120)For each duplicate section:
Use Edit tool to delete from non-canonical files
Use Edit tool to add link to canonical location:
See [Development Principles](../principles.md#development-principles) for details.
Track count of removed duplicates
Log results:
Log results:
kanban_board.mdtests/README.md (if created)Show documentation system features:
Recommend next steps:
tests/README.md