Technical writing is an umbrella term for numerous types of writing, including theses, dissertations, journal articles, reports, periodicals, even formal e-mails… the list goes on. But usually the author is trying to inform the audience, the writing is formal, the work non-fiction, and they follow a certain format. Everyone starts technical writing as early as elementary school, with book reports and essay plans. These days, most technical jobs (especially in engineering, science, and technology) involve some form of writing, from operations/training manuals to website pages to letters to clients; technical writing is a large area. This blog will indicate the highlights of what it is all about.
As technical writing generally involves instructions or explanations, the writing is always formal. There is no informal, everyday speech language (i.e., I’ll, won’t, can’t). The writing style is direct and exact – tells the audience clearly and concisely what they need to know. Assume that the audience knows nothing of the subject matter (i.e., that your knowledge is greater than theirs), and so justify and explain where necessary. Use the minimum amount of words possible (no wordy explanations); your audience are busy people who want to learn the information quickly and precisely. Use the active voice – as well as being definite, this cuts down on wordiness. (A word of caution here, this is not always possible, especially in some types of document, but use where you can.)
Usually reference material is involved and needs to be incorporated in such a way – as a reference list or end/footnotes – such that the reader can easily find it if need be. ALL abbreviations must be defined so that the reader knows exactly what is being referred to.
For instructional manuals or report writing, companies and schools normally have a set template that needs to be adhered to – for schools that could be APA, MLA, or Chicago. This ensures that every paper or set of instructions are uniform and all blend together – this is especially important for the overall image of a company.
So for technical writing, be concise, informative, formal and main the same format throughout.
At FirstEditing, we can take your technical writing and ensure that it is all the things described here. We have academic editors who can transform your theses and dissertations, along with editors with marketing experience who can ensure that your sales pitch will sell your product. Just send us your work and we’ll prove it to you!
Related posts:
- How to outsource your dissertation editing online
- Citations/References, APA, MLA
- How to find a good dissertation editor – what to know BEFORE you buy!
- How To Improve Your Writing: em dashes and ellipses
- How to Improve Your Writing: Capitalization
Tags: Christian Writing, Editing Skills & Services, fiction editing, professional editor, Technical Edit, writers, writing, Writing Process, writing tips
Kudos to you! This is a really good blog here and I love your style of writing. How did you get so good at blogging?