Latest posts by techwriter (see all)
- Test Your Knowledge of 4 Basic Fonts – Drag & Drop - January 27, 2017
- How NOT to Design a Web Site - January 25, 2017
- Hazards of Poorly Written Technical Documentation - December 26, 2016
Basically, good writing is good writing-no matter the purpose for which it is intended. However, the style of writing will differ somewhat, depending on the intended audience. Recipients of e-mail, for example, expect a more casual style, whereas a letter of agreement would have a more formal, legal tone and a process manual would enumerate sequential steps in a process.
REPORT WRITING TIPS
1) Determine your audience.
2) Define your goals.
3) Gather relevant information
4) Decide upon the format.
5) Construct the graphs/charts.
6) Draft the various sections, starting with the body.
7) Keep on objective, positive tone throughout.
8] Use the first person.
9) Use headings.
10) Begin with a summary statement.
TECHNICAL WRITING TIPS
1) Technical papers have the same objective as other reports: to share information with a select audience that needs the information in order to make a decision.
2) You need, and your writing should reflect, a specialized and thorough knowledge of
the subject matter.
3) An organized presentation of pertinent facts.
4) Logic as you develop the conclusion you reach.
5) The quality of a technical report is judged by its readability, accuracy, completeness,
clarity and degree of influence upon the audience.
6) The technical report begins with an optional Executive Summary, followed by the
Introduction; a discussion of the materials and methods used during an experiment or study.(If the methodology is standard, it should be mentioned in the Introduction.)
Next are the Results and Discussion section; Conclusions; Recommendations, Summary, and Appendices.
7) The description is the most widely used technical writing technique. After a brief introduction, you’ll give a definition and purpose, the overall description, and descriptions of the main and sub-parts.
THEY’RE JUDGING YOU
It’s been said that every time you put words on paper, you allow others to see inside your brain. If you want those ” in-sights” to reflect order, intelligence, and professionalism, pay attention to the requirements that readers expect from writers.
Dr. Marlene Caroselli is the author of 60 business books and one, just-released e-book: “Principled Persuasion–Influence with Integrity, Sell with Standards” (named a Director’s Choice by Doubleday Book Club when it first appeared in print). Contact her at [email protected] re: keynotes, training, curricula and books available for purchase.