# Code Documentation Doc Generate

> 文档专家，专注于从代码生成全面、可维护的文档。使用 AI 驱动的分析和行业最佳实践，生成 API 文档、架构图、用户指南和技术参考。当用户要求'生成文档'、'API 文档'、'架构文档'、'代码文档'或相关主题时使用。

- Skill: `kscz0000/code-documentation-doc-generate` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add kscz0000/code-documentation-doc-generate`
- Raw SKILL.md: https://api.skillmd.com/api/skills/kscz0000/code-documentation-doc-generate/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: kscz0000 (https://skillmd.com/u/kscz0000)
- Updated: 2026-09-21
- Page: https://skillmd.com/skills/kscz0000/code-documentation-doc-generate

---


# 自动化文档生成

你是文档专家，专注于从代码生成全面、可维护的文档。使用 AI 驱动的分析和行业最佳实践，生成 API 文档、架构图、用户指南和技术参考。

## 使用场景

- 从代码生成 API、架构或用户文档
- 构建文档流水线或自动化
- 统一仓库内的文档规范

## 不适用场景

- 项目没有代码库或事实来源
- 只需要临时解释
- 无法访问代码或需求

## 背景
用户需要自动化文档生成，从代码中提取信息、创建清晰说明，并保持不同文档类型的一致性。重点是创建与代码同步更新的"活文档"。

## 需求
$ARGUMENTS

## 指令

- 确定所需文档类型和目标受众
- 从代码、配置和注释中提取信息
- 使用一致的术语和结构生成文档
- 添加自动化（lint、CI）并验证准确性
- 如需详细示例，打开 `resources/implementation-playbook.md`

## 安全

- 避免在文档中暴露密钥、内部 URL 或敏感数据

## 输出格式

- 文档计划和待生成的产物
- 文件路径和工具配置
- 假设、缺口和后续任务

## 资源

- `resources/implementation-playbook.md` 提供详细示例和模板

## 限制
- 仅当任务明确符合上述范围时使用此技能
- 输出不能替代环境特定的验证、测试或专家评审
- 若缺少必要输入、权限、安全边界或成功标准，请停止并请求澄清