Doc orchestrator
AI 编程助手的专业技能库,涵盖 30+ 技能,按 6 类组织
npx -y skills add morning-start/agent-skills --skill doc-orchestratorAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
Use when the user needs a document orchestration entry point, a workflow router for document phases, or a guided overview of software documentation generation and maintenance.
SKILL.md
6.1 KB, ~2.1k tokens by cl100k_base, as published. Nobody here has run it
DocOrchestrator - 文档编排操盘手
任务目标
- 本 Skill 用于:全生命周期管理软件开发项目的各类文档
- 能力包含:项目分析、文档规划、文档生成、质量校验、变更维护、格式转换、智能绘图、版本管理
- 触发条件:用户需要"创建项目文档"、"生成需求文档"、"画架构图"、"检查文档一致性"、"需求变更分析"、"文档版本管理"等
前置准备
依赖说明
本 Skill 使用 Python 3.8+ 标准库,核心依赖:
- yaml (PyYAML) - 双轨格式处理
- json - 结构化数据
- pathlib - 路径管理
目录结构
doc-orchestrator/
├── skills/ # 阶段协调器 + 执行者
├── references/ # 全局参考
├── templates/ # 统一模板库
└── scripts/ # 自动化脚本
操作步骤
标准流程
-
分析阶段
- 调用
doc-phase-analysis分析项目类型、规模、技术栈 - 输出:
project-profile.yaml
- 调用
-
规划阶段
- 调用
doc-phase-planning根据分析结果规划文档清单 - 输出:
doc-plan.yaml
- 调用
-
生产阶段
- 调用
doc-phase-production按规划生成文档族 - 输出: 完整文档集
- 调用
-
质量阶段
- 调用
doc-phase-quality进行一致性、完整性检查 - 输出:
quality-report.yaml
- 调用
-
维护阶段
- 调用
doc-phase-maintenance管理版本、变更、同步 - 输出: 更新后的文档集 +
CHANGELOG.md
- 调用
快捷路径
- 小项目: analysis → production → quality(跳过 planning)
- 已有项目: analysis (scan) → maintenance (sync) → quality
- 仅绘图: production (diagram-producer)
- 仅校验: quality
资源索引
阶段协调器
| 协调器 | 职责 | 路径 |
|---|---|---|
| doc-phase-analysis | 项目/需求/现状分析 | 查看 |
| doc-phase-planning | 文档规划/模板选择 | 查看 |
| doc-phase-production | 文档生成/绘图 | 查看 |
| doc-phase-quality | 一致性/完整性/评分 | 查看 |
| doc-phase-maintenance | 版本/变更/同步/导出 | 查看 |
全局参考
| 参考文档 | 用途 | 路径 |
|---|---|---|
| 文档类型目录 | 查看所有支持的文档类型 | 查看 |
| 双轨格式协议 | Agent与人类格式定义 | 查看 |
| 智能绘图策略 | TXT/Mermaid选择规则 | 查看 |
| 文档SOLID原则 | 设计原则指南 | 查看 |
| 模板变量系统 | 模板变量定义 | 查看 |
| 质量指标定义 | 评分规则 | 查看 |
project-wiki(已合并)
以下资源从 project-wiki 合并而来,提供额外的模板和工作流支持:
| 资源 | 路径 |
|---|---|
| 20+ 标准模板(基础/架构/需求/知识库/检查清单) | 查看 |
| 文档工作流指南 | 查看 |
| 模板生成器与配置 | 查看 |
| 知识库(框架/模式/原则) | 查看 |
| 文档一致性检查清单 | 查看 |
注意事项
- 严格遵循三层架构(根→协调器→执行者),层级深度 ≤ 3
- 所有文档必须包含 YAML front matter(双轨格式)
- 绘图默认智能选择 TXT/Mermaid,根据复杂度自适应
- 变更维护时必须更新追溯链(traceability 字段)
- 质量评分低于阈值时需标注 warning
- 小项目自动裁剪非必要文档
使用示例
示例 1: 新项目从零生成文档
输入: "我有一个电商项目,用 React + Node.js + PostgreSQL,需要完整文档"
流程:
- analysis: 识别为全栈项目,中等规模
- planning: 规划文档清单(SRS、SAD、API、DB设计、测试策略)
- production: 按清单生成文档,智能添加图示
- quality: 校验一致性,输出质量报告
- maintenance: 建立追溯链,初始化版本
输出: 完整文档集 + quality-report.yaml
示例 2: 需求变更影响分析
输入: "原来的登录改为支持手机号验证码登录,分析影响"
流程:
- maintenance/change-analyzer: 追溯受影响的文档(SRS→SAD→API→测试)
- maintenance/doc-syncer: 同步更新相关文档
- quality: 重新校验一致性
- maintenance/version-manager: 更新版本号
示例 3: 快速生成架构图
输入: "画一个微服务架构图"
流程:
- analysis/project-analyzer: 确认架构类型
- production/diagram-producer: 智能选择 Mermaid 生成架构图
支持的文档类型
需求类
- SRS(软件需求规格说明)
- PRD(产品需求文档)
- 功能需求文档
- 非功能需求文档
架构类
- SAD(系统架构设计)
- TDD(技术方案设计)
- 平台专项架构(Web/移动/桌面/游戏)
- 数据流图
接口数据类
- API 接口文档
- 数据库设计文档
- 通信协议文档(WebSocket/gRPC/Protobuf)
质量运维类
- 测试策略与计划
- 部署运维手册
- 安全合规文档
基础类
- README
- CHANGELOG
- CONTRIBUTING
质量门禁
| 检查项 | 阈值 |
|---|---|
| 文档完整性 | ≥ 90% |
| 术语一致性 | 100% |
| 追溯完整性 | 100% 有来源/去向 |
| 双轨格式 | 100% 包含 YAML front matter |
| 图示覆盖率 | ≥ 80%(复杂文档) |