doc-generator
生成或修复高质量、类人写作风格的技术文档。
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：doc-generator。 它的用途是：生成或修复高质量、类人写作风格的技术文档。 完整的 Skill 内容见：https://321skill.com/skills/doc-generator-x-8/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
‘请为我的项目根目录下的 `api.js` 文件生成一份API参考文档，要求包含每个端点的描述、参数说明和返回示例。’，它会分析你的代码结构，提取关键信息，并生成一份格式规范、内容详实的API文档草稿。或者，
对AI说：‘这是我写的一份产品需求文档初稿，感觉语言比较生硬，请帮我优化一下，让它更专业、更流畅。’，它会重新组织语言，调整句式，使文档更具可读性和说服力。
介绍
doc-generator Skill 旨在解决技术文档编写耗时费力、质量参差不齐的问题。它能够基于代码、注释或现有草稿，自动生成结构清晰、语言流畅的文档，或对已有文档进行润色和补充，确保其专业性和可读性。
使用时，您只需提供代码文件、项目上下文或文档草稿，并指定目标文档类型（如API文档、README、设计文档等），该Skill便能理解您的意图，生成或优化相应的文档内容，显著提升文档产出效率。
它非常适合开发人员、技术文档工程师、项目经理以及任何需要频繁产出或维护技术文档的团队成员。尤其当团队缺乏专职文档人员，或希望统一文档风格和质量标准时，这个Skill能提供巨大帮助。
建议在使用时，先提供清晰的项目背景和文档目标，对于生成的初稿进行人工审阅和微调，以确保其完全符合项目特定需求。注意，它主要处理文本内容，对于复杂的图表生成或需要深度领域专业知识的内容，可能需要结合其他工具或人工干预。
核心特点
专注于生成“类人写作质量”的技术文档，而不仅仅是格式化代码注释；能够根据上下文进行文档内容的“修复”和“润色”，提升现有文档的专业性和一致性。
注意事项
不适合生成需要高度创意或特定领域深度专业知识（如法律、医学）的非技术性文档。
常见问题
doc-generator 能生成哪些类型的文档？
可以生成API文档、README、技术设计文档、用户手册等多种技术文档类型。
它如何处理已有的低质量文档？
可以基于现有文档进行内容重构、语言润色和结构优化，提升其可读性和专业性。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/doc-generator-x-8/raw/index.md 读取 doc-generator 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/doc-generator-x-8/raw/index.md（查看排版版本）