What Makes a Smart Doc Smart?
Posted on 14. Apr, 2009 by Jeremy in Burning or Building, Documentation & Training
I’m sure we can all take a tedious text procedure and make it look better by reformatting, adding graphics, or using white space better. Does that make it a smart doc? I don’t think so.
Smart docs require some planning and a lot of thought because they aren’t single pretty documents but a system of documentation that works together, is easy to use, and is rigorously logical. True smart docs can’t be developed in a silo but must be developed with the other documents in the system.
For instance, smart docs don’t repeat information in multiple places unless absolutely necessary. Information goes in the one most logical place. This sometimes requires some thinking about what that most logical place is and sometimes sparks some debate (which can be very healthy and lead to a better solution).
Smart docs also put similar information in similar documents. If information on how to operate a cartoner is in a reference manual, then information on how to operate a labeler is in a reference manual. If setup information is in a checklist on Line 2, then setup information is in a checklist for Line 6. This consistent documentation makes it easier for operators to find the information they need.
It’s not enough to have pretty documents. You need a system of smart docs.