Topic-based Authoring vs. Modular Authoring

基于主题的创作 vs 。模块化创作

2020-03-17 20:10 clickhelp

本文共582个字,阅读需6分钟

阅读模式 切换至中文

We hear the term "topic-based authoring" quite a lot. ClickHelp is software for help writers that supports the topic-based approach. But how did it come to be? What makes topic-based authoring superior in modern techcomm? And, finally, how is it different from modular help writing? Let's try figuring this out. Predecessor of Topic-Based Authoring For technical writers, it all began with so-called narrative authoring. Since the day first technical documentation was written, up until quite recently there was only narrative authoring. It means that when you needed to create a technical document describing a certain process or containing instructions on how to go about this process, you would just open a clear page and start writing each technical document from the title to its end. That's how help authoring was done for hundreds of years. But, of course, when the concept of online documentation came about, things started shifting rapidly. Underlying Reasons for Topic-Based Approach to Appear What is a topic to start with? Wikipedia describes it as 'a discrete piece of content that is about a specific subject, has an identifiable purpose, and does not require external context to understand.' It is clear that using topics as the primary items of technical documentation is extremely convenient, as this allows building a coherent structure of topics that can be intuitively navigated with the help of a table of contents. But there's more. The rise of new age technical documents started in the ‘90s. Documentation began moving away from printed formats. Online help systems became the moving force behind topic-based technical writing. The main reason for the topic-based approach to become a thing is content reuse. As soon as creating user manuals became more tied to using help authoring tools, the idea of content reuse revolutionized the industry and showed direction for further development. Not only topics can be reused, but also their parts. This approach keeps evolving as modern tools for help writers are continuously improving this functionality. You can read on single-sourcing techniques available in ClickHelp to see for yourself how far we've come in providing great content reuse options. Modular Authoring In reality, topic-based authoring can be part of modular authoring. A modular authored project presupposes that different techcomm experts are working on different parts of it. And, they can still be applying the topic-based approach. This practice is common for technical writing in military, shipping, aircraft, etc. The modular approach relies heavily on standards. Otherwise, the final product will be just a compilation of data that one won't be able to merge due to incompatible formats. Standards bring order to this process and allow modular authoring to be successful. On a side note, you might want to get acquainted with the notion of Simplified Technical English as it will give you more insight into standards and how the techcomm society is working together to improve them through simplification making adoption and learning curve easier for new users. Conclusion Topics like this give us the opportunity to see the bigger picture. Which is always nice - we can truly see how the technical writing industry keeps changing. With content reuse becoming possible tech writers got the opportunity to focus more on UX, content depth and quality. With all these changes and approaches, better user manuals are to come! Good luck with your technical writing! ClickHelp Team Author, host and deliver documentation across platforms and devices
我们听到的术语“基于主题的创作”相当多。ClickHelp 是支持基于主题的方法的帮助编写程序的软件。但这是怎么回事?什么使得基于主题的创作在现代技术中更具优势?最后,它和模块化帮助编写有什么不同? 让我们试着解决这个问题。 基于主题的创作序言 对于技术作家来说,这一切都始于所谓的叙事创作。自从第一次技术的文档被写,直到最近才有叙事创作。这意味着,当您需要创建一个描述某个流程的技术文档或包含有关如何处理此流程的说明时,您只需要打开一个清晰的页面,然后开始从标题到结尾编写每个技术文档。 这就是几百年来帮助创作的方法。但是,当然,当文档的概念出现时,情况开始迅速变化。 基于主题的出现方式的根本原因 从什么话题开始?Wikipedia 将其描述为“关于特定主题的离散内容,具有可识别的目的,并且不需要外部上下文来理解。' 显然,将主题作为技术文档的主要项目是非常方便的,因为这允许构建一个连贯的主题结构,可以借助目录直观地导航。但还有更多。 新时代技术文件的兴起始于90年代。文档开始远离印刷格式。在线帮助系统成为基于主题的技术写作的推动力。 基于主题的方法成为事物的主要原因是内容重用。一旦创建用户手册与使用帮助创作工具更加紧密地联系在一起,内容重用的理念就彻底改变了行业,并为进一步的发展指明了方向。 不仅可以重用主题,还可以重用它们的部件。这种方法随着帮助作者不断改进这种功能的现代工具而不断发展。您可以阅读 ClickHelp 中的单源技术,了解我们在提供大量内容重用选项方面取得了多大进展。 模块化创作 实际上,基于主题的创作可以是模块化创作的一部分。模块化编写的项目假设不同的技术专家正在对其不同部分进行研究。而且,他们仍然可以应用基于主题的方法。这种做法在军事、航运、飞机等领域的技术写作中很常见。 模块化方法严重依赖于标准。否则,最终产品将只是数据的编译,由于格式不兼容,无法合并这些数据。标准为这个过程带来了秩序,并允许模块化创作成功。 另一方面,您可能希望了解简化技术英语的概念,因为它将使您更深入地了解标准以及技术社区如何通过简化来改进标准,使新用户更容易采用和学习曲线。 结论 这样的话题让我们有机会看到更大的图景。这总是很好-我们可以真正看到技术写作行业的变化。随着内容重用成为可能,技术作者有机会更多地关注 UX 、内容深度和质量。所有这些变化和方法,更好的用户手册即将到来! 祝你的技术写作好运! 单击帮助团队 跨平台和设备创作、托管和交付文档

以上中文文本为机器翻译,存在不同程度偏差和错误,请理解并参考英文原文阅读。

阅读原文