模块化编写最佳实践
使用 Draft Space,您可以在主题中编写内容,从而优化内容以便重复使用。与经典编写相比,这种模块化的编写方式需要改变一些习惯。
完善模块化编写可能需要大量练习。但是,遵循一小套基本规则可以帮助您在不增加作者工作量的情况下对文档做出贡献。
模块化编写的优点
将内容划分为单用途主题,使其易于重复使用和重新组织:
- 这些主题可以包含在许多不同的文档中,也可以在单个文档中进行复制。
- 您只需更新一个主题一次,而不管该主题在多少个位置使用。
- 许多作者和贡献者可以并行处理内容,而不必担心内容的组织方式。
只有在内容的编写方式不受结构和顺序的任何变化的影响时,才能获得这些好处。
单用途主题
只为一项内容编写主题。如果需要描述几个内容,请不要犹豫:创建多个主题。然后,这些主题可以列在作为章节标题的父主题下。
适当的标题和简短描述
读者首先看到主题的标题和开头几个字,然后选择是否要选择链接并查看整个主题内容。因此,标题和第一段应有助于作出这一决定。
标题应涵盖所有主题,且仅涵盖主题(如果您创建单用途主题,这当然更容易)。
简短描述 (shortdesc) 提供主题的第一个段落,我们建议您始终创建一个。当读者将鼠标悬停在标题上时,简短描述通常会显示在信息提示中,从而帮助读者了解主题是否值得阅读。它不总结内容,而是介绍内容。我们建议您也尝试将简短描述的长度保持在 300 个字符以下。
独立
可以在文档中移动主题。有些可能会被添加,有些会被删除,有些会重新排序。因此,在内容中,您不能引用之前和之后的内容,这一点至关重要。理想情况下,应将主题编写得好像周围没有其他内容。实际上,主题通常单独显示。