怎样写一份清晰的社区使用说明
使用说明应回答四个问题:这里提供什么、读者怎样完成主要任务、什么行为适合在这里发生、遇到问题时应该如何整理信息。
开头先讲适用对象和实际能力
一份社区使用说明不应从复杂规则开始。先用简短文字说明读者来到这里能获得什么,例如阅读主题文章、查看常见问题、理解参与规范。随后说明能力边界,避免把纯知识页面写得像已经具备账号、发帖或客服处理功能。
海角社区、服务专题提供自助帮助知识,页面中的流程用于阅读与学习。这个定位也说明了写说明的一个原则:入口名称和实际能力必须一致。只有普通阅读页面,就使用阅读指南、查看清单之类的名称;不能把它包装成提交成功、立即受理或专属客服。
为第一次来的读者安排最短路径
先挑出最常见的三个任务,分别用一小段说明。对于知识社区,可以是寻找主题、阅读完整文章、理解如何反馈内容问题。每个任务给出起点、动作和完成结果,让读者不用读完整本说明也能开始。
写步骤时先自己走一遍实际页面,使用页面上的准确名称。若文章目录和专题导航含义不同,就在说明中解释:前者列出文章内部章节,后者引向其他文章。对新读者来说,这类看似细小的差异往往决定他是否能够顺利返回。
- 起点:从哪个真实入口开始。
- 动作:需要选择、阅读或记录什么。
- 结果:完成后应到达哪里或获得什么。
- 例外:入口不存在或内容未覆盖时,怎样继续。
参与规范要给出情境和理由
只写文明交流往往不足以指导具体行为。可以补充与主题相关、引用他人内容时交代出处、区分事实和意见、不公开无关个人信息等具体做法,并解释这些做法如何帮助讨论继续。规则应服务于共同理解,避免堆叠空泛口号。
教学情境:有人在文章下讨论一个不同主题,原问题因此被淹没。说明可以建议将新主题放在适当位置,并在原讨论中简要说明关联。若所处页面没有讨论功能,就不应编写发帖流程,而应把这个例子明确当作一般社区参与知识。
把例外放在相关步骤附近
帮助说明常见的问题是开头很简单,重要限制全放在末尾。读者执行到一半才发现不适用,会产生更多困惑。更好的方法是在步骤旁写明条件,例如仅适用于文章正文内的查找,或这是阅读安排而非实际活动报名。
同样,不要把所有异常都归为请联系客服。如果没有公开且真实的渠道,说明应帮助读者保存问题记录,并解释本站不能处理的事项。无法承诺的处理时限、恢复结果和服务范围,都不应写成既定事实。
修订说明时检查名称和路径
页面调整后,先检查说明里的入口名称、链接和截图是否仍对应实际内容,再检查步骤顺序。只更新日期而不修正文案,会让读者误以为内容已经重新验证。没有实际核对就不要使用已全面更新等表述。
可以把修订分为三类:文字更清楚、路径发生变化、规则范围改变。前一类通常只需改写表达;后两类需要重新检查相关步骤和链接。最后请一个不熟悉内容的人只按说明完成任务,记录他停顿的位置。这种记录能用于改进说明,但不能冒称正式用户研究结果。
延伸问答
使用说明应该覆盖所有情况吗?
先覆盖主要任务和容易误解的边界,再通过相关链接补充细节。强行把所有例外塞在开头会影响阅读。
可以使用虚构案例吗?
可以用于教学,但应明确标注,并让案例只说明表达或操作方法,不伪装成真实用户经历。