Editing Modular Documentation: Some Best Practices
Presentation Abstract
Much has been said about the creation of topic-based modular documentation—from content management systems, to information architecture, to delivery forms, and so on. However, not much has been said about the editing of that content, and what the editor’s role is in such an environment.
In this presentation, we will learn some best practices to apply when editing modular documentation, and see how they work using before-and-after examples. We will also look at what editors need to do to have a positive impact on the creation of readable and usable modular documentation.
Meet the Presenter
Yoel Strimling has been an editor for 20 years, and currently works as the Senior Technical Editor/Documentation Quality SME for CEVA Inc. in Herzelia Pituach, Israel. Over the course of his career, he has successfully improved the content, writing style, and look and feel of his employers’ most important and most used customer-facing documentation by researching and applying the principles of documentation quality and survey design.
Yoel is a member of tekom Israel, a Senior Member of STC, and the editor of Corrigo, the official publication of the STC Technical Editing SIG. He can be contacted at [email protected].