跳到主要内容

本文阅读时长:约 1 分钟

操作手册使用说明

说明操作手册的组织方式:按角色成册、按任务分节,每节给出前置条件、操作步骤与结果确认。

写作框架(完稿后删除)

小节标题即最终目录。每节给出:要讲什么 / 写法 / 素材 / 来源。 写法模板(A 概念阐述、B 分步操作、C 参考速查、D 流程走读)、截图与图表规范见仓库根目录 WRITING-GUIDE.md

手册的结构约定

本节要讲:操作条目的统一写法。

写法:模板 A。展示一个完整示例条目(用「重置密码」这类简单操作做样板),把「前置条件 → 步骤 → 结果确认 → 常见问题」四段结构演示一遍。后续各册全部照此格式。

素材

  • 示意图:一个完整操作条目的样板(真实可用的内容)

来源:WRITING-GUIDE.md 模板 B

注意:这个样板本身要写成成品质量,它是各册的写作标尺。

确定角色与分册

本节要讲:按职责确定所属角色与对应分册。

写法:模板 C。表:研究中的主要职责(通俗描述)→ 对应角色 → 对应分册(链接)。表头用名词性短语。

素材

  • 表格:三列对照表,覆盖六册

与「功能」章节的关系

本节要讲:分工说明。

写法:两句话:功能讲能力与概念,手册讲步骤;手册中概念一律链接功能章节不展开。

截图与版本说明

本节要讲:界面差异处理。

写法:两句话:截图基于版本 X;界面差异不影响步骤逻辑,以实际为准。