NOTE: *THIS PRESENTATION HAS ANIMATIONS.* It will be easier to follow if you download and open it in PowerPoint.
In rapidly-growing companies where the number of technical writers rises and the number of deliverables maintained by the documentation team grows dramatically, it becomes essential to develop a system of content management that is well-organized, consistent, and optimized to support long-term expansion and maintenance. In this presentation, I provide some practical guidelines and techniques for designing a scalable documentation project architecture in collaborative environments where growth is the norm. Although the presentation focuses on how to do this specifically for help authoring tools such as MadCap Flare, the underlying principles discussed are tool-agnostic.
What you should know beforehand:
-- What MadCap Flare is
-- What single-source publishing and content reuse are
What you will learn:
-- Why version control is essential when you have a growing team of writers
-- Practical ideas for organizing projects and folders at the right level of granularity, with team collaboration and scalability factors in mind
-- Guidelines for policies your team can use when creating reusable content such as graphics, CSS, snippets, and other resources
-- The pros and cons of various folder structure strategies and file naming conventions
-- Practical ideas for developing team-wide resources to ensure everyone follows the same standards