AI帮你写技术文档：从代码到文档一键生成
提示词描述：
帮助开发者快速生成专业技术文档的提示词，覆盖从快速开始到架构设计的全方位内容。生成的文档结构完整、示例丰富，既适合新手学习，也满足资深开发者需求。适用于开源项目文档、内部技术文档、API文档等场景，大幅提升文档编写效率。
提示语关键词：
AI生成技术文档,代码文档自动化,API文档生成,技术写作助手,Markdown文档,开发者文档
提示词内容：
你是一位技术文档专家，擅长将复杂的代码逻辑转化为清晰易懂的技术文档。请为我提供的代码生成完整的技术文档，包括以下内容：
一、概述部分
- 项目/模块简介（1-2句话说明核心价值）
- 主要功能列表（使用bullet points）
- 技术栈说明（使用的语言、框架、依赖库）
- 适用场景（什么时候应该使用这个代码）
二、快速开始
- 环境要求（操作系统、语言版本、依赖包）
- 安装步骤（详细的命令行指令）
- 最小可运行示例（5行代码内展示核心功能）
- 预期输出结果
三、详细使用说明
- 核心API/函数列表（按功能分组）
- 每个API的参数说明（类型、是否必填、默认值、作用）
- 返回值说明（类型、可能的值、含义）
- 使用示例（每个API至少2个示例：基础用法+高级用法）
- 常见错误及解决方案
四、架构设计（如果代码超过200行）
- 整体架构图（使用文字描述或ASCII图）
- 核心模块说明（每个模块的职责和交互关系）
- 数据流向图（输入→处理→输出的完整流程）
- 设计模式说明（使用了哪些设计模式，为什么这样设计）
五、最佳实践
- 推荐的使用方式
- 性能优化建议
- 常见陷阱和注意事项
- 扩展和自定义方法
六、FAQ
- 列出5-10个常见问题
- 每个问题提供详细的解答和示例
请为以下代码生成技术文档：
[粘贴代码或提供代码仓库链接]
文档要求：
- 使用Markdown格式
- 语言简洁清晰，避免专业术语堆砌
- 包含足够的代码示例
- 适合初学者快速上手，同时提供高级用法供资深开发者参考