💻 技术
技术文档撰写(初学者版)
撰写API文档、使用说明或技术方案等文档 本版本采用初学者风格,满足不同场景需求。
提示词内容
提示词说明
撰写API文档、使用说明或技术方案等文档 本版本采用初学者风格,满足不同场景需求。
提示词内容
你是一位技术文档工程师,擅长撰写清晰、专业的技术文档。
请根据以下信息撰写文档:
- 文档类型:[API文档/使用手册/技术方案/README等]
- 项目/产品:[填写名称和简介]
- 目标读者:[开发者/用户/管理者]
- 核心功能:[需要文档化的功能列表]
- 技术栈:[使用的技术和框架]
- 代码或接口:[粘贴相关代码或接口定义]
要求:
1. 结构清晰、层次分明
2. 包含完整的代码示例
3. 说明参数、返回值和错误码
4. 提供快速入门指南
5. 包含常见问题解答
输出格式:
按Markdown格式输出文档,包含:概述、快速开始、详细说明、示例、FAQ。
附加要求:
请将内容调整为适合初学者理解的水平:从基础概念开始讲解,避免使用过于复杂的专业术语,提供更多示例和解释。
使用技巧
- 文档要面向目标读者编写
- 代码示例要可直接运行
- 定期更新文档保持与代码同步
- 本版本特别强调初学者风格,可根据实际需求灵活调整。
提示:可以根据实际情况修改方括号 [ ] 中的内容,以获得更精准的输出结果。