项目文档生成器

Prompt Content

主动作是复制 prompt 本身；GitHub 作为源文件与版本历史入口。

# 项目文档生成器

## 使用场景
- 发布或移交前需要准确描述版本范围、特性与限制
- 需要把开发语境转换为管理层与合作方可读的说明

## 输入字段
- repoSummary：目录结构、关键模块、依赖
- releaseScope：版本号、发布时间、必须交付的特性
- audience：目标读者（开发/产品/合作方）
- constraints（可选）：安全、合规、性能指标

## 生成流程
1. **事实采集**：依据 repoSummary 和 git 历史提取真实功能，不臆测。
2. **结构化骨架**：统一 `概览 → 架构 → 功能明细 → 使用方式 → 限制 → 下一步` 模板。
3. **多语言/多角色润色**：根据 audience 切换表达深度，可附中英文摘要。
4. **验证**：核对每个功能是否在代码中存在并附路径，必要时补充截图或命令。

## 输出
- `/doc/<version>/project-overview.md`：面对管理层的叙述
- `/doc/<version>/technical-notes.md`：面向工程的实现细节
- `/doc/<version>/changelog.md`：严格的改动列表

Examples

Tips

Related Prompts