Creating Useful Documentation

Wrap up

Once you understand the field, understand your users, and understand your product, you're ready to start writing great documentation. The next step is to know how to combine what you've learned to explain what the product is supposed to do. This can be a difficult job, especially if you are writing without any of the knowledge discussed above. Unfortunately, technical writers rarely have the luxury of taking the time to learn everything I've talked about; deadlines loom, budgets shrink, assignments are given at the spur of the moment.

As you become more familiar with technical writing, you'll begin to get a feeling for how to find the right balance of information for your target audience. A little guidance from your coworkers will go a long way as well. Happy writing!

Was this article useful? Did I leave something out? Let me know!!!

 


Hokum Writing