Here are the basics for getting started in technical writing:
Focus on your audience. Your audience needs to get work done. You help them. To help them, you must stay aware that your goal is to enable them to act.
Think of audiences as members of your community who expect that whatever happens will happen in a certain way and will include certain factors—your proposal is expected to include certain sections covering specific topics. When you act as members of the community expect other members to act, your message will be accepted more easily.
Audiences have experiences that may cause them to read your message in a different way than you meant.
Use presentational strategies. Presenting your message effectively helps your audience grasp your message.
- Use the top-down strategy (tell them what you will say, then say it).
- Use headings (like headlines in newspapers).
- Use chunks (short paragraphs).
- Establish a consistent visual logic by making similar elements in your document look the same.
- Use a plain, objective style that lets readers easily grasp details and relationships.
These strategies are easy to learn, but they take practice to use skillfully. They are your repertoire. Master them.
Assume responsibility. Because readers act after they read your document, you must present a trustworthy message. In other words, readers are not just receptacles for you to pour knowledge into by a clever and consistent presentation. They are stakeholders who themselves must act responsibly, based on your writing.