指令模板：技术文档设计与结构化内容架构 | AIGC实践

【题外话】

在上一篇文章中，有朋友反馈说，【见睿思齐】的字号设置得太小了，读起来有点儿费劲。

首先，特别感谢这位热心读者，开诚布公地与我分享感受，提出宝贵意见，帮助我做得更好。

因此在这篇文章中，我尝试将字号调大1号。大家看看是否还有其他问题，欢迎随时向我提出。

【言归正传】

最近加入了一个“神秘”组织，叫做【了不起的指令工程师】。在这里，我们认同指令在AIGC中的价值，无论是指导ChatGPT输出文本，还是指导Midjourney输出图像，都少不了Prompt的加持。

正如李彦宏在《大模型即将改变世界》的演讲中说的那样：自然语言人机交互会带来提示词革命。未来，世界50%的工作是提示词工程；提出问题比解决问题更重要。

所以我们将尝试输出可以被复用的指令模板，让更多人可以轻松上手，使用AIGC工具解决典型场景的问题。

主题图 by Midjourney。Prompt：Structured Content Architecture --ar 16:9 --s 750 --niji 5

【背景说明】

研发工程师在参与文档开发时往往会出现：不知道如何入手；不知道该写哪些内容；输出的内容逻辑结构不清晰。主要问题在于，在文档开发前，没有对文档内容大纲，进行合理设计。

为了解决这个让研发困扰的“老大难”问题，我们可以尝试通过指令，指导ChatGPT输出内容大纲，作为参考，并结合实际场景，进行必要修改，从而帮助研发工程师，更好地进行文档写作。

【指令逻辑】

• 角色：技术文档工程师
• 背景：明确技术文档工程师应具备的能力，便于ChatGPT理解。
• 任务：设计指定文档；输出内容架构
• 要求：
  • 明确面向对象
  • 明确信息目标
  • 明确主要内容
  • 明确写作规范

【指令示例】

假如你是一个资深的技术文档工程师，请为应用示例的开源代码设计一个开发说明，输出文档内容大纲。

背景：技术文档工程师是负责编写、编辑、组织和维护产品技术文档的专业人员。他们的主要职责是将复杂的技术信息转化为易于理解和使用的文档，以帮助用户和其他利益相关者更好地了解和使用该产品。技术文档工程师需要具备良好的技术与写作能力，能够熟练运用各种工具和软件来创建和管理文档，并能够根据不同的受众和场景来编写不同类型的文档，例如用户手册、安装指南、故障排除指南等。他们还需要与产品开发团队和其他相关部门紧密合作，确保文档与产品的开发和更新保持同步。

要求：

• 面向对象：应用开发工程师；合作伙伴
• 信息目标：
  • 帮助读者获取、编译、运行开源代码；
  • 指导读者在应用示例代码的基础上，理解业务逻辑、编程原理；
  • 指导读者结合实际场景，进行应用程序开发。
• 主要内容：
  • AI计算产品的图像编解码应用
  • 主要系统模块包括前端开发、后端开发和业务开发
  • 聚焦说明代码的业务逻辑和实现原理说明；
  • 不需要展开说明编程接口的调用方法。
• 写作规范：
  • 符合金字塔原理；
  • 包含2~3级目录；
  • 层次结构为：
    • 一级标题：1、2、3
    • 二级标题：1.1、1.2、1.3
    • 三级标题：1.1.1、1.1.2、1.1.3
    • 以此类推
  • 尽可能依据已有信息，补充文档内容；或者给出写作提示。

【ChatGPT输出】

以下内容由GPT-3.5输出：

开发说明文档大纲

前言

- 说明文档的目的、范围和读者对象

- 术语表和缩略语解释

第一章：概述

1.1 产品介绍

- 产品的背景、目标和应用场景

- 产品的主要功能和特点

- 产品的架构和技术选型

1.2 系统模块

- 前端开发模块

- 后端开发模块

- 业务开发模块

1.3 代码结构

- 代码的组织结构和目录结构

- 代码的主要文件和类的功能介绍

- 代码的依赖关系和模块划分

第二章：环境准备

2.1 开发环境

- 操作系统和开发工具的选择

- 依赖库和框架的安装和配置

- 开发环境的准备和调试技巧

2.2 运行环境

- 硬件配置和操作系统要求

- 运行环境的安装和配置

- 运行环境的监测和优化

第三章：代码实现

3.1 前端开发

- 前端技术栈和框架的选择

- 前端页面的设计和开发

- 前端组件和模块的实现

3.2 后端开发

- 后端技术栈和框架的选择

- 后端服务和API的实现

- 后端模块和组件的实现

3.3 业务开发

- 业务需求和流程的分析

- 业务逻辑和数据模型的设计

- 业务模块和功能的实现

第四章：应用部署

4.1 部署方式

- 部署的目标和环境要求

- 部署的方式和流程

- 部署的检测和优化

4.2 运维管理

- 运维任务和工具的介绍

- 运维策略和流程的设计

- 运维监控和故障处理的技巧

第五章：示例应用

5.1 应用场景

- 应用场景和业务需求的描述

- 应用场景和业务流程的分析

- 应用场景和业务模型的设计

5.2 应用实现

- 应用需求和功能的实现

- 应用逻辑和数据模型的实现

- 应用界面和交互的实现

第六章：参考资料

6.1 参考文献

- 主要参考文献和链接的介绍

- 参考文献的引用和解释

6.2 常见问题

- 常见问题和解决方法的总结

- 常见问题和解决方法的案例分析

6.3 开发者社区

- 开发者社区和资源的介绍

- 开发者社区和资源的互动和分享