# Project Doc Generator

> Generate and maintain project documentation systems from structured inputs. Use when (1) creating documentation from spec/requirements/design/tasks, (2) planning doc dependency order and generation sequence, (3) incremental doc updates with consistency checks, (4) generating docs with correct depth for target audience. Focuses on dependency-aware, incremental, audience-appropriate documentation.

- Skill: `bingooyong/project-doc-generator` (Agent Skill)
- Install (CLI): `npx skillmds@latest add bingooyong/project-doc-generator`
- Raw SKILL.md: https://api.skillmd.com/api/skills/bingooyong/project-doc-generator/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: bingooyong (https://skillmd.com/u/bingooyong)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/bingooyong/project-doc-generator

---


# 项目文档生成 Skill

基于规格化输入（spec / requirements / design / tasks），生成项目交付文档体系。关注文档依赖关系、生成顺序、一致性、增量更新。

## 何时使用

- 项目初始化时需要生成文档体系
- 收到新的需求/设计/任务规格，需要生成或更新对应文档
- 文档缺口分析后需要批量补齐文档
- 需要按读者角色生成不同深度的文档

**不适用**：单文件临时说明、代码注释、与文档体系无关的纯文本输出。

## 输入

| 输入类型 | 说明 | 必需 |
|----------|------|------|
| 项目上下文 | 项目类型、技术栈、团队规模 | 是 |
| 规格文档 | spec / requirements / design / tasks 的路径或内容 | 至少一项 |
| 目标文档类型 | 要生成哪些文档（不指定则按缺口分析） | 否 |
| 读者角色 | 开发/测试/运维/产品/客户 | 否（默认开发） |
| 已有文档路径 | 用于增量更新 | 否 |

## 输出

- 生成的文档文件（Markdown）
- 文档依赖关系图（文字描述）
- 生成顺序说明
- 每份文档的读者角色与深度说明
- 与已有文档的变更摘要（增量更新时）

## 执行步骤

### 1. 分析输入与项目上下文

- 读取并理解所有输入的规格文档
- 确定项目类型（Web 应用 / API 服务 / CLI 工具 / 库 / 数据管道 / 其他）
- 确定项目阶段（初始化 / 开发中 / 测试 / 发布 / 维护）
- 列出已有的文档及其状态

### 2. 确定文档需求

按项目类型和阶段，确定需要的文档清单：

```
初始化阶段: README, 项目概述, 文档索引
开发阶段: 架构设计, 详细设计, API 文档, 数据库设计
测试阶段: 测试计划, 测试用例, 验收标准
发布阶段: 部署手册, 发布说明, 运维手册
维护阶段: Runbook, ADR, FAQ
```

### 3. 排序生成顺序

按依赖关系排序：
1. **基础层** — README, 项目概述, 术语表, 文档索引
2. **设计层** — 架构设计, 详细设计, 数据库设计
3. **接口层** — API 文档, 接口契约
4. **运维层** — 部署手册, 运维手册, Runbook
5. **质量层** — 测试计划, 验收标准, 发布说明

依赖规则：上层文档可引用下层，下层不依赖上层。

### 4. 按顺序生成

对每份文档：

1. 检查是否已有该文档
   - **已有且有效** → 增量更新，不重写
   - **已有但过时** → 标记过时部分，更新内容
   - **不存在** → 按模板生成
2. 从规格文档和项目上下文中提取内容
3. 按读者角色调整深度和语言
4. 确保术语与已有文档一致
5. 添加元数据（版本、状态、更新时间）

### 5. 一致性校验

- 术语一致性：同一概念在所有文档中使用相同术语
- 引用一致性：交叉引用路径正确
- 版本一致性：版本号、日期在所有文档中对齐
- 深度一致性：同一读者角色看到的文档深度一致

## 边界与非目标

- **不做**文档治理（盘点、缺口分析、质量校验）— 这属于文档治理能力
- **不做**自动发布或部署文档
- **不做**替代代码中的内联文档和注释
- **不做**多语言文档翻译
- 依赖用户提供的规格文档质量，规格不完整时会在文档中标记"待补充"

## 验收标准

- 每份生成的文档有明确的读者角色和适用场景
- 文档间交叉引用路径正确
- 术语使用一致
- 增量更新时保留了有效的原有内容
- 所有从规格中提取的内容都有明确来源
- 无法确认的内容标记为"待确认"而非编造