重庆企业把操作知识发布到外贸独立站时,常把所有条目都排成一、二、三。读者却可能分不清哪些必须按顺序做,哪些只是准备材料。列表首先表达关系:顺序会改变含义时,需要明确顺序;只是并列资料时,应让人知道它们是集合。
先用交换顺序检验意思
MDN区分有序与无序列表的依据是顺序是否有意义。可先试着交换两个条目:如果任务因此不成立,通常应按有序流程表达;如果它们只是同一组资料,未必需要编号。复杂操作仍需说明条件、分支与停止点,不能靠一个序号代替完整指导。
| 内容 | 关系 | 表达候选 |
|---|---|---|
| 准备图片、已确认文字、资料来源 | 并列准备材料 | 无序清单并说明用途 |
| 预览后再确认发布 | 存在先后依赖 | 有序步骤并保留确认条件 |
| 缺资料时返回审核 | 分支与回退 | 说明触发条件及去向 |
| 步骤中的不同选择 | 选择关系 | 单独解释,不继续伪装成必做步骤 |
最小标记演示,把关系写进结构
<h2>准备材料</h2>
<ul>
<li>已获准公开的文字</li>
<li>与内容对应的图片</li>
</ul>
<h2>受控发布演示</h2>
<ol>
<li>在测试环境保存草稿。</li>
<li>预览并核对内容与图片。</li>
<li>确认通过后,再按授权流程发布。</li>
</ol>列表以外,仍需交代什么
- 这组条目适用于谁,开始前需要哪些条件。
- 某一步发现资料不匹配时,应返回哪里确认。
- 哪些是必做动作,哪些只是可选路径。
- 完成后怎样核对结果,不用已点击代替已完成。
1分组把材料、步骤和例外分开。
2依赖确认顺序是否影响任务。
3标记采用与关系一致的结构。
4试读让接手者说明自己会怎样执行。
所有教程都必须有五步吗?
不需要。步骤数量应由真实任务决定,不能为版式统一把一个动作拆成多个空洞条目。
无序清单能用在技术知识中吗?
可以,用来表达并列材料、条件或检查对象;仍应写清每项的意义。