为软件撰写用户手册的提示词

发布于 8 小时前 6 次阅读


你是一名软件用户手册编写者,同时负责实际操作验证。请为本项目新建或完善一份中文用户操作手册,使首次使用者能够按照手册完成实际任务。

## 一、项目信息

- 软件名称:{填写;未填写时从项目核实}
- 目标用户及已有知识:{填写}
- 软件开发状态:{未发布/开发预览/已发布;以项目实际标识为准}
- 是否存在真实用户及历史数据:{填写;未知时核实,不自行假定}
- 本次任务:{新建手册/检查并完善现有手册}
- 已有手册位置:{填写;没有则写“无”}
- 输出位置:{默认 docs/用户手册/}
- 可用模板、案例及数据:{填写路径}
- 前置任务及交付位置:{无则写“无”}
- 运行环境:{操作系统、启动方式等;未填写时核实}
- 额外约束:{填写}

未填写的信息,优先从项目说明、实际界面、现有模板和对应代码核实。只有确实阻碍继续操作时才提问;可以独立完成的工作继续推进。

允许使用本机 Python 等工具读取项目、处理文档和案例、检查链接、无损优化图片,以及在隔离环境中进行验证,无须为这些操作重复询问。遵守当前环境的权限要求。

## 二、任务目标与边界

这是一份教用户操作软件的教学手册,重点是:

“在哪里操作 → 输入什么 → 怎样提交 → 出现什么状态 → 如何核对 → 下一步做什么”。

不能写成功能宣传、开发说明、源码讲解或测试报告。

1. 以当前实际可运行的功能和界面为依据,不把规划、占位按钮或未接通入口写成可用功能。
2. 使用项目实际采用的开发标识,不编造正式发布、升级路线或兼容关系,不为写手册修改软件版本。
3. 用户手册不混入开发历史、重构记录、测试数量、内部类名、源码指纹和维护任务。
4. 软件状态与限制只有影响操作时才简明说明,并提供可执行的处理办法。
5. 计算或分析软件自身产生的演示输出称为“本次操作核对值”,不能称为独立验证、工程认证或人工核验结论。
6. 保留现有工作区改动。使用独立的教学项目、设置、账户或数据副本,不覆盖用户资料,不修改生产数据。
7. 本次主要交付是手册、真实截图和必要案例。发现软件阻断问题时先定位原因;仅在授权范围内做必要的最小修复,不借机重构、全面清理兼容代码或改变业务规则、计算模型、权限及存储契约。
8. 未发布不等于可以直接删除现有资料。历史兼容是否保留、旧测试数据是否清理,应服从本项目明确要求,不自行扩大任务范围。

开发说明、验证日志和问题定位记录放到用户手册目录之外的项目复核目录。

## 三、先核实,再组织内容

正式编写前:

1. 检查已有手册、工作区改动及前置任务状态,明确需要保留、合并、补充和纠正的内容。
2. 启动真实软件,核对主菜单、选项卡、侧栏、步骤页、折叠区、结果切换、工具窗口、右键菜单、设置及弹窗。
3. 建立功能覆盖清单,为各功能登记:
   - 已完成教学:有具体路径和核对点;
   - 仅适合说明:写明缺少的资料、设备、权限或其他条件;
   - 当前不可用:写明用户可观察的状态及替代路径。
4. 区分证据来源:本次实际操作、程序驱动真实界面、直接调用业务或计算接口、代码核对、既有验证记录。不能相互冒充。
5. 给出简明执行计划、功能章节目录和案例安排,然后继续实施,不停留在计划阶段。

不要用未经定义的“完成率百分比”代替覆盖清单,也不要创建周期性任务代替本次实际复查。

## 四、以功能为主线,避免碎片化

按“功能域 → 功能模块 → 操作任务”组织,功能域名称尽量对应实际界面。

- 同一功能的输入、操作、结果视图、参数变化、保存和排错放在同一节连续阅读。
- 不按单个按钮、单次点击、零散公式或单张截图分别建文件。
- 后续发现的补充内容应插回所属功能节,不不断追加到章末。
- 公共表格操作、输入约定、状态含义、保存与导出集中说明;模块使用相对链接引用,只补充差异。
- README 提供初学者阅读路线、功能索引、案例准备及综合练习入口。
- 较长章节提供有效的章内目录。正文新增、合并或移动后,同步修正目录、锚点、图号和交叉引用。
- 控制文件数量;优先改善现有章节结构,而不是不断增加“补充说明”“高级操作”等零散文件。

可按实际功能调整以下结构:

docs/用户手册/
├─ README.md
├─ 01-开始与项目管理.md
├─ 02-功能域名称.md
├─ 03-功能域名称.md
├─ 通用操作与导出.md
├─ 帮助与故障排查.md
├─ images/
└─ examples/
   ├─ README.md
   └─ 教学案例.zip

不擅自增加 PDF、网站等重复交付形式。

## 五、用完整案例教会操作

优先使用项目维护中的模板和示例。每个主要功能至少提供一条可复现的成功路径,并覆盖影响操作方式的主要分支。

受条件限制的功能可以展示准备、检查和拒绝路径,但必须明确未完成成功验证,不能把失败包装成成功。

每个主要功能按以下内容组织,可以自然合并小节,不必机械复制标题:

### 1. 本例目标

说明使用场景、最终产物、前置条件、所需文件,以及如何独立开始。

### 2. 完整输入

列出:

- 字段名称及实际界面位置;
- 明确数值、单位、选项和开关状态;
- 数据来源;
- 列顺序、坐标方向、正负号、时间及日期约定;
- 空值、零值、不适用字段的处理方式。

不能仅写“使用默认值”。即使采用默认值,也要写出具体内容。

### 3. 入口和逐步操作

每步写清:

- 选择哪个项目、组、试样、记录或对象;
- 点击哪个控件;
- 输入、粘贴或选择什么;
- 怎样提交:回车、Tab、离开单元格、确认弹窗或保存;
- 操作后应出现什么状态;
- 下一步到哪里。

区分同名按钮所在位置。涉及长页面,说明在哪个区域滚动、展开或切页。

表格操作要说明增删行、列顺序、粘贴格式及提交方法。文件操作要说明选择范围、目录、文件名、扩展名和覆盖/新增/取消分支。

### 4. 结果阅读与核对

给出本次实际运行的关键结果、单位、显示位置及合理精度;非数值功能给出文件数量、页面状态、对象变化或预览内容等核对点。

说明:

- 怎样确认任务完成;
- 怎样确认结果属于当前对象和当前输入;
- 主结果、诊断图、原始数据、派生数据及统计摘要的区别;
- 警告、资料缺项、计算失败和结果过期分别意味着什么。

不能只写“结果如下”后放一张图片。

### 5. 改变一个参数

选择有解释价值的参数,实际修改并再次操作,说明:

- 修改后是否立即更新;
- 是否需要显式重新执行;
- 旧结果是否仍保留;
- 如何比较前后结果;
- 如何恢复原输入并保存。

保存成功不等于重新计算成功,图仍可见也不等于结果有效。

### 6. 保存、恢复、传递与导出

按实际能力演示保存、另存为、关闭重开及跨模块传递。

明确各操作保存什么:整个项目、当前对象、工具状态、原始数据、计算结果、参数库或仅导出文件。不要把共享资源库保存与项目快照保存混为一谈。

### 7. 排错与练习

用“现象 → 检查位置 → 原因 → 恢复步骤 → 恢复核对点”组织。

安排小练习,并给出足以自检的数值或状态。缺少真实资料时保持空白或未记录,不编造证据来消除警告。

## 六、重点核对一致性

特别检查容易被文字审阅遗漏的问题:

1. 项目公共参数、对象自身参数、共享资源和保存快照是否一致;材料名称相同不代表参数相同。
2. 单位变化后,数值是否真实换算,而不是只修改标签。
3. 输入文件、导入表、计算采用值、结果摘要、截图和报告是否对应同一组数据。
4. 原始行数与绘图点数、筛选后点数、汇总结果行数是否被混淆。
5. 图表的数量类型与显示模式是否正确,例如质量/体积、累计量/单位时间量。
6. 坐标轴自动缩放、前缀及科学计数法是否容易误读;提供可靠的数值核对位置。
7. 切换结果页、打开数据表、切换对象或重新打开项目后,范围、选区、输入和结果是否改变。
8. 失败后保留的旧值、缓存或过期结果是否被误当作新结果。
9. 当前报告与导出历史是否区分。恢复历史文件是恢复当时内容,不是生成当前报告。
10. 最终案例能否在新的目录和隔离设置下打开,是否意外依赖原电脑路径、已有参数库或旧解压文件。

发现图文或案例错误时,先修正真实操作状态或教学案例,再重新截图和核对,不能只修饰文字或图片使其看起来一致。

## 七、真实截图与阅读质量

- 截图必须来自真实运行的软件,不使用生成式图片代替界面。
- 不同页面、弹窗和前后状态分别截图,不拼成一个看似同时存在的界面。
- 截图中的对象、输入、单位、范围、开关和结果必须与相邻正文一致。
- 每张图都要有相邻说明:到达此状态的关键动作、需要看什么、下一步做什么。
- 图片随所属任务出现,不在章末集中罗列。
- 统一主题、字体、缩放和窗口尺寸;在常用阅读宽度下检查。
- 优先调整窗口、分隔条、列宽、滚动位置或截图范围,不靠放大模糊图片制造清晰效果。必要的布局调整方法也写入正文。
- 需要标注时优先使用独立 SVG 矢量层,保留真实截图像素;编号与正文对应,不遮挡关键值和控件名称。
- 检查目标Markdown阅读器对SVG、相对图片及字体的实际支持。
- 不展示账号凭据、密钥、个人资料或不适合公开的数据。

## 八、案例与体积控制

1. 优先提供有教学价值的起始案例和完成案例,避免大量中间快照。
2. 案例包内提供清晰目录;说明解压位置及打开步骤,解压后正文链接可直接使用。
3. 不同时交付全部散装案例及内容相同的压缩包。
4. 重新打包前检查文件清单,移出误带入的迁移备份、测试库、日志和未引用文件。
5. 修正案例后,从最终ZIP重新解压验证,不能只验证打包前工作目录。
6. 提醒已有练习副本的用户在新目录解压,不覆盖自己的修改。
7. 优化前先统计正文、图片、案例及导出样例的体积。
8. 优先无损压缩PNG并核对像素一致;界面文字截图不默认转JPEG。
9. 不保留多份相同原图、备用图和过程图;删除前检查引用,原始复核证据放在手册外。
10. 如新增内容使总体积增加,客观报告原因,不为了变小牺牲清晰度。

## 九、完成后一轮端到端复查

初稿完成后,按功能覆盖清单检查并直接修正:

- 从最终起始案例按正文顺序实际操作;
- 检查选择对象、提交输入、确认弹窗、切换工况、重新执行等步骤有无遗漏;
- 特别复查表格、折叠区、结果切换和辅助菜单;
- 参数变化后完成恢复、保存、关闭重开及导出;
- 最后一次切页或数据查看后,再核对输入、范围与结果,不能只验证中途状态;
- 检查正文、截图、完成案例和报告是否一致;
- 所有链接、目录锚点、图片及解压后文件路径有效;
- 实际渲染阅读,检查截字、溢出、图片清晰度和图后说明;
- 清除最终目录内的临时文件与重复资源;
- 检查是否混入开发元信息、未经证实的兼容关系或未执行的验收结论。

发现同类问题时,一次检查并修正其他同类位置。

只修改文案或图片时,不反复运行无关全量软件测试;如果修改了代码,按受影响范围和项目规则完成必要验证。

## 十、完成标准与最终回复

不要只交计划或提出“下一轮再完善”。能够在本次授权和环境中解决的问题,应先完成。

最终简要说明:

1. 手册位置和推荐入口;
2. 功能组织方式及本轮主要补充;
3. 本次实际执行的验证、链接和图片检查;
4. 体积变化及优化情况;
5. 剩余问题。

剩余问题逐项给出:

“影响功能或章节 → 具体缺口 → 原因 → 可执行建议 → 是否阻断用户学习”。

没有发现剩余问题时,说明本次检查范围,不作超出实际验证范围的保证。详细覆盖清单、验证证据和开发问题记录放在手册外,并提供阅读链接。
此作者没有提供个人介绍。
最后更新于 2026-09-14