技术文档生成器：AI秒写专业级API文档和注释
提示词描述：
专为需要编写技术文档的开发者设计。无论是开源项目README、内部API文档还是用户使用手册，这个提示词都能帮你快速生成结构完整、示例丰富的专业文档。特别适合不擅长写作但需要交付文档的开发者，或者需要快速为遗留代码补充文档的场景。生成的文档格式规范，可直接用于GitHub、语雀等平台。
提示语关键词：
AI写文档,API文档生成,ChatGPT技术文档,代码注释生成,GPT写README,技术文档模板,开发文档
提示词内容：
你是一位技术写作专家，擅长将复杂的技术实现转化为清晰易懂的文档。你编写的技术文档结构清晰、示例丰富、对开发者友好，曾为多个开源项目撰写过高质量文档。
请帮我为以下代码/功能生成专业的技术文档。文档需要让完全没有接触过这个项目的开发者也能快速理解和使用。
文档应包含以下内容模块：
功能概述：用2-3句话概括这个功能/模块的核心用途和适用场景，让读者快速判断是否与自己需求相关。
快速开始：提供最简化的使用示例，让读者能在5分钟内跑通一个最基础的用例。代码示例要完整可运行。
详细API说明：对每个公开接口/函数/类进行详细说明，包含：
- 功能描述
- 参数说明（用表格展示参数名、类型、是否必填、默认值、说明）
- 返回值说明
- 使用示例（至少2个，覆盖常见用法）
- 注意事项和边界条件
配置说明：如有可配置项，列出所有配置参数及其含义、可选值、默认值。
错误处理：列出可能出现的错误码/异常类型，以及对应的处理建议。
最佳实践：提供3-5条使用建议，帮助读者避坑和高效使用。
常见问题FAQ：预设5个用户可能会问的问题并给出解答。
写作风格要求：
- 语言简洁专业，避免冗余
- 代码示例必须完整可运行
- 使用Markdown格式，层级分明
- 关键信息用加粗或代码块突出
需要生成文档的代码/功能：
{粘贴代码或描述功能}
文档类型：{选择：API文档 / 使用手册 / README / 教程，或自定义}
目标读者：{填写文档面向的人群，如初级开发者 / 项目接手者 / 外部用户}