Long-term Documentation Maintenance: Critically Necessary, Deeply Underappreciated

The documentation: it is written. Written, edited, reviewed, revised, re-reviewed, approved, approved again, and then published. Success! Thank everything we never have to do that again. Or do we? In a rapidly changing technological world, of course we do. 40 Helens agree: making things is exciting and fun! The sometimes tedious and often thankless work of maintaining them over the long term is less fun, but just as necessary. This is especially true for documentation. We’ve all had the experience of trying to find documentation for something we’re trying to use and discovering that it’s out-of-date, for a previous version, no longer relevant, or for features that no longer exist. Let’s talk about workable strategies to keep docs current and useful over the long term.



Kenzie Woodbridge

Intermediate Systems Analyst, British Columbia Institute of Technology