doc-generator
生成或优化技术文档，提供高质量写作
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：doc-generator。 它的用途是：生成或优化技术文档，提供高质量写作 完整的 Skill 内容见：https://321skill.com/skills/doc-generator-x/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
‘请根据这段Python Flask API的代码和注释，生成一份完整的API接口文档，包含端点描述、请求/响应示例和参数说明。’，它会分析代码结构，提取关键信息，并组织成一份清晰易读的Markdown格式API文档。或者，你可以说：‘帮我优化下面这段晦涩的项目README，让它对新手更友好。’，它会重写内容，改善逻辑流和语言表达。
介绍
doc-generator 旨在解决技术文档编写和维护的难题。无论是项目初期需要从零开始创建API文档、用户手册，还是对现有晦涩、过时的文档进行优化和重写，它都能提供帮助。
使用时，用户只需提供原始材料（如代码注释、草稿或需求说明），该技能便能理解上下文，生成结构清晰、语言流畅、符合技术写作规范的文档。它支持多种文档格式，并能根据反馈进行迭代修改。
该技能特别适合开发人员、技术文档工程师和项目经理，他们常常面临文档与代码脱节、写作耗时或文档质量参差不齐的问题。对于非母语技术写作者，它也能有效提升文档的专业性和可读性。
建议在使用时，先明确文档的目标读者和核心目的，并提供尽可能准确的上下文信息。对于高度专业或领域特定的术语，初次生成后可能需要人工复核和微调，以确保绝对准确。
核心特点
专注于生成“类人”高质量的技术写作，而非简单的模板填充或代码转译，能理解上下文并产出结构严谨、语言自然的文档。同时支持对现有低质量文档进行智能重构和润色，提升整体可读性与专业性。
注意事项
不适合用于创作需要高度创意或文学性的非技术类内容，如小说、诗歌或营销广告文案。
常见问题
doc-generator 能生成哪些类型的文档？
可以生成API文档、技术方案、用户手册、项目README、系统设计文档等多种技术类文档。
它如何保证文档的准确性和时效性？
它基于您提供的上下文（如代码、注释）生成，但关键的技术细节和版本信息仍需人工最终核对与更新。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/doc-generator-x/raw/index.md 读取 doc-generator 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/doc-generator-x/raw/index.md（查看排版版本）