通常,将信息按上下文进行分组有助于用户完成复杂任务、了解一系列相关任务或展示完整的工作流程。使用组合多种内容类型的长篇文章,可确保用户在正确的位置找到上下文内容。长篇文章还能帮助消除内容重复,并在产品添加更多选项时,使内容具备可扩展性。用户在实际使用产品时最常需要长篇文章,并且可能在工作流程的不同阶段查阅该文章。
如何在文章中组合多种内容类型
- 在长篇文章中使用概念性、过程性、参考性、故障排除或已知问题的内容,且不要使用快速入门或教程。
- 根据需要在文章中使用不同内容类型的章节,并遵循相应内容类型的标题指南。
- 通常,这类文章至少包含一个过程性章节,以及至少一个额外的概念性、参考性或过程性章节。
- 使用内容排序指南来组织文章内的标题。
- 尽可能频繁地使用故障排除信息。
- 如有需要,可在标题中重复文章的标题。
组合多种内容类型的文章标题指南
- 如果文章中包含过程,请使用以动名词开头的任务型标题。
- 标题应足够概括,以描述文章中包含的信息和任务范围。
- 标题描述被切换的设置,而不针对读者选择的具体设置,例如使用“设置仓库可见性”而不是“将私有仓库公开”。