doc-generator
生成或优化技术文档，提供高质量写作
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：doc-generator。 它的用途是：生成或优化技术文档，提供高质量写作 完整的 Skill 内容见：https://321skill.com/skills/doc-generator-x-3/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'请为项目根目录下的 `api.js` 文件生成一份API接口文档，说明每个端点的功能、参数和返回值。'，它会分析代码中的函数和注释，自动生成结构清晰、描述准确的Markdown格式API文档。或者，您可以说：'帮我优化这段用户指南，让它更通俗易懂。'，它会重新组织语言，使文档更符合目标读者的阅读习惯。
介绍
doc-generator Skill 旨在解决技术文档编写耗时、质量参差不齐或内容过时的问题。它能够基于代码、注释或现有草稿，自动生成清晰、结构化的文档，或对已有文档进行内容补充、语言润色和格式优化，显著提升文档编写的效率与专业性。
使用时，您只需提供相关的代码文件、项目上下文或文档草稿，并指定期望的文档类型（如API参考、用户指南、README等），该Skill便会调用AI模型进行分析和创作，输出符合技术写作规范的文档内容。
该Skill特别适合开发人员、技术文档工程师、项目经理以及任何需要产出高质量技术文档的团队成员。对于不擅长写作或希望快速统一团队文档风格的场景尤其有帮助。
建议在使用前明确文档的目标读者和核心要点，并提供尽可能准确的上下文信息，以获得更贴合需求的输出。对于高度专业或涉及机密的内容，建议生成后仍需人工复核以确保准确性与安全性。
核心特点
专注于技术文档的生成与优化，而非通用写作，能更好地理解代码结构和项目上下文，确保生成的文档技术准确、术语规范。
注意事项
不适合生成需要深度行业洞察或高度创意性的非技术类文案（如营销广告、小说创作）。
常见问题
doc-generator 能生成哪些类型的文档？
可以生成API文档、用户手册、技术方案、README、项目报告等多种技术相关文档。
它如何处理已有的旧文档？
可以基于旧文档进行内容补充、语言润色、结构重组和格式优化，实现文档的迭代升级。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/doc-generator-x-3/raw/index.md 读取 doc-generator 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/doc-generator-x-3/raw/index.md（查看排版版本）