What is Technical Writing?
Two of the six definitions of the word "technical" by Merriam Webster are:
- having special and usually practical knowledge especially of a mechanical or scientific subject
- marked by or characteristic of specialization technical language
Technical writing is said to be the art of simplifying the complex. It falls under the field of technical communication and entails communicating complex concepts, ideas, procedures or processes to an audience who may have varying level of knowledge on the topic.
The Goal of Technical Writing
Technical writing is geared to result in conveying relevant, useful and accurate information to readers either to simply impart knowledge or to be used as guides to achieve specific outputs. Other uses are for:
- Product specifications and descriptions
- Operating procedures
- End-user documentation
- Definitions of terms
- White papers
- Portions of
- Proposals
- Recommendations
- Feasibility studies
Technical writing is mainly used for information-technology-related industries, architecture, medicine engineering and scientific research. With the exponential growth in the cryptocurrency space, this skill can be applied in the presentation of project roadmaps, development updates and overall presentation and dissemination of any technical aspect of the project. Some upcoming projects would usually run bounty programs involving technical writing such as spreading awareness about the project via various social media platforms in exchange of free coins or tokens.
Indicators of an Effective Technical Document
A good technical document is well-researched, extensive relevant information is collected from trusted subject matter experts and is presented using correct grammar and spelling. The four indicators below are a good start to ensure that an effective document is drafted.
1. Commands attention and achieves desired results.
Keep in mind that potential audience doesn’t know what’s in your document nor where to find what they want in your document. Depending on the audience's purpose for reading the document, reader may or may not actually read your entire work. You may consider sharing stories, analogies or examples to illustrate a point. Use positive language to reinforce message. Review the written document and change passive verbs to active ones whenever possible to make writing more expressive. A way to ensure that your sentence is in the active voice is by starting the sentence with the subject. The Rhetorical Triangle is also a helpful guide to keep your readers engaged.
2. Complex or technical information are simplified with the use of graphics and other aids
A picture does paints a thousand words, and actual spoken words can sometimes be the only way to ensure the idea is conveyed as intended. With this, it is very important to choose the supporting material included in the document to ensure audience's full understanding.
3. Content is clear, concise and relevant.
Be sure ideas are clear and easy to follow. Signal the reader via heading use or introductory paragraphs usage. Headings provide an overview of the document's value to the reader and allows them to find what they need quickly. Creating an outline prior to actual writing is a good way to ensure structure is maintained in the content. Plan your time to allow for proofreading and correcting.
Image Source
4. Highly technical information are expressed in simple terms.
When writing for a diverse group that may include non-technical audience, keep the technical language to a minimum. If jargon and technical terminologies are used, definition must be provided at all times. Language and terminology needs to be adjusted to the characteristics and needs of the audience. A good way to ensure this is accomplished is by having a non-technical person have a read-through on your work and solicit their insight on what terms or sections may be needing further explanation.
Sources:
What is Technical Writing
Merriam-Webster
Five Steps to Effective Technical Writing for Project Leaders
If you would like to support initiatives on community building and enrichment, kindly check out 
Consider casting your witness votes for 
To cast your votes, just go to
https://steemit.com/~witnesses
Type in the box the witness account, example below for