In my last documentation post, I talked about the 9 essential rules for writing documentation.
To ensure that your audience accept and use your documentation, there are Four Key Pillars to writing user documentation.
The Four Key Pillars ensure the audience can:
- FIND the information they want, easily.
- UNDERSTAND the information when they do find it.
- Rely on the information being ACCURATE
- Rely on the information being COMPLETE
Miss any of these, and your target audience won’t use the documentation you spent time crafting.
My next post on Thursday, will discuss how to apply these Four Key Pillars to your documentation.
On this day..
- What is that font? - 2010
- The iPhone Enterprise Deployment Guide - 2009
These could be the very pillars I need to get my nursing notes right!
What? Continuing education? They do that there?
These could be the very pillars I need to get my nursing notes right!
What? Continuing education? They do that there?
[...] next documentation post on Tuesday, will discuss the Four Key Pillars of Writing User [...]
[...] my last documentation post, I talked about the 4 Key Pillars of writing user documentation. This post is about how to apply [...]