Configuration Guides: How To Document Parameters

If you want your customers to keep using your products, make sure every parameter settings is correctly documented. So, how can you write glittering configuration guides that sparkle and amaze when customers print out the PDF? Here’s how, grasshopper. Make sure to capture the following when documenting every parameters in your technical documents. No excuses, […]

How to Perform a ‘Post Mortem’ on Technical Documents

After every major release, do a post mortem of your technical documentation and look at how you can improve team morale, writing process, document reviews, and the documentation product. Post-mortems focus on two areas Quantitative data — such as, the difference between the project estimate and the hours worked. Qualitative data — such as, satisfaction, […]