We polled writers and did some research on the internet to find these useful technical writing tips:
1. Establish and maintain good relationships with your subject matter experts… cookies help!
2. Remember, subject matter experts are busy too. Don’t waste their time and try to keep this in mind when setting up a review cycle.
3. It is important that you develop excellent interviewing skills.
4. Make a plan. This will make it easier to incorporate new information into your documents as the project progresses or when the software is revised. Working without a plan creates extra work later on.
5. Know your subject. There are some things that cannot be faked. If you don’t understand what you're writing it will show because your reader won't understand it either. You cannot explain what you do not know.
6. Keep it simple.
7. Create a file-naming convention that makes sense to you and to others.
8. Learn to love deadlines. While you can tell how long you think it's going to take to write something, what most clients really want to know is, "can you have it done by such-and-such a date?"
9. Wherever possible, put your subject up front and make it do something. The active voice generally works better than the passive voice because it’s more direct, more concise, and easier to understand.
10. If you encounter a day when it’s hard to focus, try writing randomly rather than linearly to avoid “writer’s block.” Write small chunks of content that you can fit together later. Don’t get stuck because you don’t know how to fit them together right now.
11. Let your content sit for a few hours or days, if you can. Come back to it later after you’ve taken a break.
12. When you review your document, imagine you are reading it for the first time from the user's point of view. Assume the user does not know it already and that you need to explain it. If your document contains any sentences that you don't understand, assume the user won't understand them either and rewrite them.
13. Read it out loud. If it sounds too complicated, it probably is. Make sure it sounds as natural as technical language can possibly be.
14. Avoid technical specification if you don't want to be stuck writing the same old thing for the rest of your life. Develop a broad technical range, and keep abreast of current technology. Pick five technical areas and stay on top of them. You'll be happier -- and more consistently in demand -- in the long run.
15. Always keep your resume up-to-date.
No comments found.
Post a comment (login required)










