创建成功的风格指南
作者:Sean Watson,ServiceNow
创建风格指南是一项艰巨的任务。风格指南包含语法标准、语音和语调指南、要使用和避免的词、复制模式以及产品品牌的基础知识。这些文档很容易变得非常乏味以至于难以使用,或者非常简单以至于无法满足需求。它们也可能很快过时,变得无关紧要。以下是创建成功的风格指南的一些想法。
-
不要重新发明轮子。不要覆盖与Microsoft 风格手册等风格指南相同的内容 ,而是在更广泛的风格指南的上下文中定义您的专有内容。
-
收集您的专有条款列表,并与相关利益相关者核实它们。此列表应包括任何特定于产品或功能的术语,这些术语应在文档中以一致的方式使用。还应收集并与利益相关者一起验证不在更广泛的风格指南中的产品或功能之外使用的术语,以实现标准化。风格指南应该是标准化的总和。纳入利益相关者创建了一个一致性的交汇点,并增加了通过文档的可能性。通过定义术语,品牌也得到了加强。基础术语通过使用的更广泛的风格指南来解决。
-
允许其他人修改它。风格指南应该是活生生的文档,会根据产品和功能、语音和语气标准以及利益相关者的愿望的变化进行更新。最好记住,风格指南的想法是保持整个文档的一致性,而不是强加法律规则。语言是流动的。因此,将会出现挑战该文件的案例。这些变化可以反映在风格指南的更新、例外情况或加强文档的权威性上。
-
使您的风格指南更易于访问。使用诸如 SharePoint 之类的内部网站来创建您的风格指南,并确保利益相关者知道它的存在。您还可以将链接发送给其他团队,以提高对文档的认识并吸引他们的贡献。
-
将尽可能多的写作团队、UX 设计师、UX 研究人员、开发人员等的内容纳入风格指南。让多个团队使用风格指南可以提高整个组织的采用率和一致性。除此之外,这些团队不必重新发明轮子,可以在您的文档的基础上进行构建。在这种情况下,让每个团队都可以为自己的内容创建部分。
英文原文:
https://www.infomanagementcenter.com/creating-a-successful-style-guide/