MadWorld Austin Icon

The Premier Technical Communication and Learning & Development Conference | June12-15, 2022

Register Now

Why Documenting Your Project is Crucial to Staying Organized - Part 1

Presented By:

Neil Perlin, Certified Flare Trainer and Consultant | Hyper/Word Services


Webinar Summary

The best authoring solutions are of little use if you lose control of the project. New authors may not understand how a feature was used or why. And it’s painful to leave your project for a few months, return to it, and not remember what you did. The solution? Document the project.

Many authors don’t because they think it takes too long but you can document a project in three days. The result isn’t a style guide; it’s a full description of the project with details like topic attributes, file structure, graphics settings, approved tools, and more.

With this information at hand, authors can better stay on track and new authors won't have to try to read their predecessors’ minds. This webinar series describes how to quickly document a project. It focuses on what items to document but also looks at how to manage the document to keep it up to date and viable. Problems will still crop up with the project – they always do – but once you document your project, losing control won’t be one of them.

Part 1 of the webinar covers general aspects of documentation specs, getting started, and specifics, with part 2 covering the remaining specifics.