当为重用内容进行写作时,必须做到:
- 一致
- 与语境无关
- 通用
在可能的情况下,通过将通用信息与特定信息分离,你能保证你的通用内容块在任何需要的情况下足够通用以适合重用。
使你的内容一致:
- 使topic简短并以较小的体量来承载信息,可以发挥重用的最大潜能。只有一级标题的简短topic比含有大量信息包含多个部分的长篇topic更适合在多处重用。
- 建立一个打标签和用法的风格指南(或者至少,在用法上达成一致并预留一些时间来记录这些共识形成以后正式的风格指南的基础。)
- 使用一致的语态以及特定的词汇和术语,让你的topic更适合重用。限制使用代词(特别是与性别相关的代词),并避免使用成语和口语。一致的语态不仅有助于重用,也有利于本地化。
让你的内容不依赖上下文:
- 不要假设topic之前或之后有任何相关信息。不要使用例如之前、之后、前面、后面之类的词。
- 不要设想内容所使用的文档类型。不要使用诸如本章或本节之类的短语。
- 不要使用内联交叉引用。在你的内容版本中,交叉引用目标是存在的,但是在内容被重用之后的map里,这种关联性就不存在了。替代方案是:使用DITA关系表来自动产生指向相关topic的链接。
让你的写作更加概括化:
- (只要有可能)避免使用关键词或者产品附属物。例如,如果同一套说明可用于多个产品,就不要提及产品特定的引用信息。
- 不要过于特定,除非非常必要。避免在你的内容中使用不必要的修饰成分,比如数目、大小或颜色。因为产品随着时间变化,这些特定信息可能会发生变化,因此不利于重用。
要达到让内容通用适合重用与包含必要的详情之间的平衡,可以考虑在每个标识特定产品信息的交付件的开头增加一张表或者清单。通过提前提供信息,你可以从内容中移除关键字,并依赖通用术语。
通用内容不仅能帮助重用,也能为本地化铺路。重用同时意味着你总体上只有更少的topic需要翻译,帮助你减少本地化成本。
参与人员