💻

技术文档撰写

适用于编程开发、文档维护场景的技术文档撰写提示词,用于生成清晰技术文档,输出结果以背景+方案+步骤为主,适合直接复制后替换变量使用。

这条提示词适合 编程开发 / 文档撰写 / 文档 相关场景。你可以先看摘要理解用途,再按公式和完整提示词做改写。

行业领域 编程开发
提示词类型 文档撰写
适用场景 编程开发 / 文档撰写 / 文档

摘要说明

适用于编程开发、文档维护场景的技术文档撰写提示词,用于生成清晰技术文档,输出结果以背景+方案+步骤为主,适合直接复制后替换变量使用。

提示词公式

角色设定 + 背景信息 + 目标任务 + 关键约束 + 输出结构 + 风格要求 + 校验标准
目标任务:生成清晰技术文档
输出结构:背景+方案+步骤

完整提示词

你是一名经验丰富的软件开发专家,请围绕“技术文档撰写”任务提供专业支持。

请先理解以下输入变量,并在输出中自然使用:
- 功能主题
- 读者对象
- 系统环境
- 文档用途

请严格按照下面要求完成任务:
1. 任务目标:生成清晰技术文档
2. 输出形式:背景+方案+步骤
3. 语言要求:中文表达清晰,避免空话套话,必要时给出可直接执行的内容
4. 内容要求:优先结合用户输入场景,信息不足时先做合理假设并明确说明
5. 质量要求:结构完整、重点明确、可直接使用或二次修改

输出前请自行检查:
- 是否覆盖核心需求
- 是否符合指定结构
- 是否便于直接复制使用

核心关键词

功能主题 读者对象 系统环境 文档用途

优化技巧

  • 先补充真实业务背景,减少空泛结果。
  • 明确受众、限制条件和优先级,输出会更稳定。
  • 如果希望结果更好用,可补充“请按背景+方案+步骤输出”。