Here are seven quick tips to improve the quality of your technical documents. When you write a technical document, consider the following points:
Category Archives: Technical Writing
Doug Davis from ProEdit asks some interesting questions about the state of the tech writing industry, in particular, the demand for new writers. “You sit in your favorite comfy chair and open the Sunday newspaper. The economy is steadily improving. Good. Unemployment rates are down. Nice. You’ve seen all the data. You’ve read the reports. […]
I was recently asked how to start documentating for a Banking solution which is been developed in Java on Open-Source platform. What kind to documents should i write for this project? Now, there isn’t much to go on here, so… It depends on what the client actually wants. Here’s what I’d do: 1. Ask the […]
Though the terms Usability and Information Architecture are often understood to be the same thing, this is not true. Usability This tends to study a person’s ability to do (i.e. use) something, such as reading text on a webpage. Usability is not restricted to the web and is used across many industry sectors. For example, […]