create account

Four Indicators of Effective Technical Writing by dreamiely

View this thread on: hive.blogpeakd.comecency.com
· @dreamiely · (edited)
$47.62
Four Indicators of Effective Technical Writing
## 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. 
#
<center>http://zaetric.com/wp-content/uploads/2014/12/technical-writing.jpg
<sup>[Image Source](http://www.zaetric.com/technical-writing/)</sup>
</center>

#
## 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.

<center>http://photos1.blogger.com/blogger/2598/872/1600/reading.jpg
<sup>[Image Source](https://digest.bps.org.uk/2006/02/16/against-speed-reading/)</sup>
</center>
### 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.
<center>
https://www.mtmlinguasoft.com/wp-content/uploads/jargon.png
<sup>[Image Source](https://www.mtmlinguasoft.com/business-jargon-a-problem-for-international-communication/)</sup>
</center>
### 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](https://techwhirl.com/what-is-technical-writing/)
[Merriam-Webster](https://www.merriam-webster.com/dictionary/technical)
[Five Steps to Effective Technical Writing for Project Leaders](http://blog.learningtree.com/five-steps-to-effective-technical-writing-for-project-leaders/)
#
______
If you would like to support initiatives on community building and enrichment, kindly check out @steemph, @steemph.cebu, @steemph.iligan, @steemph.davao and @steemph.manila

Consider casting your witness votes for @precise, @steemgigs @cloh76.witness and @ausbitbank who have been adding invaluable contribution to the community.

To cast your votes, just go to 
https://steemit.com/~witnesses

Type in the box the witness account, example below for @precise

<center>https://steemitimages.com/DQmejW9BSWVyJsky81M8yUAFoGeezUCc2qyRQ178ZwyoeRs/PhotoGrid_1508407211498.jpg</center>
#
_______
#
 <center>https://steemitimages.com/DQmUsvPR4ETEWpsBHzXmRRixJSW1jhPKzJUDce9pGHa9ZSq/DREAMY.png</center>
#
<center>
![dreamielygif.gif](https://steemitimages.com/DQmSijmFjGwpZ9Ua6Mo6rjGyJyYiksWggbKL4uNS5xkTsqt/dreamielygif.gif)
#
![thealliance_ladies_3.png](https://steemitimages.com/DQmc75yMiEvNZwe9U2sA7t4ghotVDAWpZp3VsJaRYaJ3fDV/thealliance_ladies_3.png)
</center>
#
 https://steemitimages.com/DQmPfsDRe925ntDQJvu63QB4pFW28L175RgxFg58GBPSonw/follow_dreamiely.gif
#
<center>https://steemitimages.com/DQmcNgj7SaQifxc26PDGqTovrVgppXvoDm76SzNa6Y2KCVK/dreamiely.png</center>
#

<center>
[<img src="https://steemitimages.com/DQmVQrDs6xxkawTu2AwJHz3tJPJ4KoQ8pDE8Z1tBNiWsy6F/icons8-Facebook-48.png">](https://www.facebook.com/groups/steemph/) [<img src="https://steemitimages.com/DQmePngvRuq8Ft1xyqf4hY9qtxgVfgpBMCdspMrdWkgyLs4/icons8-Instagram-48.png">](https://instagram.com/steemph) [<img src="https://steemitimages.com/DQmeNWoNEQKywWT5V9a8QK5UkT5hTZzUoKRbAYoQaYGBwYZ/icons8-Flag%202-48.png">](https://facebook.com/steemph) [<img src="https://steemitimages.com/DQmeoCA2q2aGvid9XWDfz6nQMzYrWhDhcDE9h9yD9eRWAPA/icons8-Discord-48.png">](https://discord.gg/kQ7JXz2) [<img src="https://steemitimages.com/DQmfXNpohTyQpGry5EKQvzqGLUTBm3fXXvtYQpq1v9YWEmX/icons8-Paint%20Palette-50.png">](https://blog.artguildph.rocks) [<img src="https://steemitimages.com/DQmSZpJtwbcTuWWHv71kcuzKZ6DKsfaotpFt88Q2Pu6KcCE/icons8-WordPress-48%20(1).png">](https://steemph.wordpress.com/) [<img src="https://steemitimages.com/DQmbRjnusVVSZhkYVdzim2NTDvy6oi28iVbDDfDRe6g8cTj/icons8-Tumblr-48.png">](https://steemph.tumblr.com/maintenance)
https://steemitimages.com/DQmYrjAgxHF4Q5XX9MhPaVbJAZqst5iEj4Rhv4tuuiWZLry/4343523532322222.png
</center>
👍  , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , and 20 others
properties (23)
authordreamiely
permlinkfour-indicators-of-effective-technical-writing
categorywriting
json_metadata{"tags":["writing","sndbox","philippines","steemph","thealliance"],"image":["http://zaetric.com/wp-content/uploads/2014/12/technical-writing.jpg","http://photos1.blogger.com/blogger/2598/872/1600/reading.jpg","https://www.mtmlinguasoft.com/wp-content/uploads/jargon.png","https://steemitimages.com/DQmejW9BSWVyJsky81M8yUAFoGeezUCc2qyRQ178ZwyoeRs/PhotoGrid_1508407211498.jpg","https://steemitimages.com/DQmUsvPR4ETEWpsBHzXmRRixJSW1jhPKzJUDce9pGHa9ZSq/DREAMY.png","https://steemitimages.com/DQmSijmFjGwpZ9Ua6Mo6rjGyJyYiksWggbKL4uNS5xkTsqt/dreamielygif.gif","https://steemitimages.com/DQmc75yMiEvNZwe9U2sA7t4ghotVDAWpZp3VsJaRYaJ3fDV/thealliance_ladies_3.png","https://steemitimages.com/DQmPfsDRe925ntDQJvu63QB4pFW28L175RgxFg58GBPSonw/follow_dreamiely.gif","https://steemitimages.com/DQmcNgj7SaQifxc26PDGqTovrVgppXvoDm76SzNa6Y2KCVK/dreamiely.png","https://steemitimages.com/DQmVQrDs6xxkawTu2AwJHz3tJPJ4KoQ8pDE8Z1tBNiWsy6F/icons8-Facebook-48.png","https://steemitimages.com/DQmePngvRuq8Ft1xyqf4hY9qtxgVfgpBMCdspMrdWkgyLs4/icons8-Instagram-48.png","https://steemitimages.com/DQmeNWoNEQKywWT5V9a8QK5UkT5hTZzUoKRbAYoQaYGBwYZ/icons8-Flag%202-48.png","https://steemitimages.com/DQmeoCA2q2aGvid9XWDfz6nQMzYrWhDhcDE9h9yD9eRWAPA/icons8-Discord-48.png","https://steemitimages.com/DQmfXNpohTyQpGry5EKQvzqGLUTBm3fXXvtYQpq1v9YWEmX/icons8-Paint%20Palette-50.png","https://steemitimages.com/DQmSZpJtwbcTuWWHv71kcuzKZ6DKsfaotpFt88Q2Pu6KcCE/icons8-WordPress-48%20(1).png","https://steemitimages.com/DQmbRjnusVVSZhkYVdzim2NTDvy6oi28iVbDDfDRe6g8cTj/icons8-Tumblr-48.png","https://steemitimages.com/DQmYrjAgxHF4Q5XX9MhPaVbJAZqst5iEj4Rhv4tuuiWZLry/4343523532322222.png"],"links":["http://www.zaetric.com/technical-writing/","https://digest.bps.org.uk/2006/02/16/against-speed-reading/","https://www.mtmlinguasoft.com/business-jargon-a-problem-for-international-communication/","https://techwhirl.com/what-is-technical-writing/","https://www.merriam-webster.com/dictionary/technical","http://blog.learningtree.com/five-steps-to-effective-technical-writing-for-project-leaders/","https://steemit.com/~witnesses","https://www.facebook.com/groups/steemph/","https://instagram.com/steemph","https://facebook.com/steemph","https://discord.gg/kQ7JXz2","https://blog.artguildph.rocks","https://steemph.wordpress.com/","https://steemph.tumblr.com/maintenance"],"app":"steemit/0.1","format":"markdown","users":["steemph","steemph.cebu","steemph.iligan","steemph.davao","steemph.manila","precise","steemgigs","cloh76.witness","ausbitbank"]}
created2017-12-14 12:23:39
last_update2017-12-14 12:25:57
depth0
children4
last_payout2017-12-21 12:23:39
cashout_time1969-12-31 23:59:59
total_payout_value37.620 HBD
curator_payout_value10.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length7,147
author_reputation16,743,022,599,252
root_title"Four Indicators of Effective Technical Writing"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id23,487,969
net_rshares7,879,581,865,255
author_curate_reward""
vote details (84)
@ratticus ·
$0.14
My biggest problem with writing essays in school/uni was always expanding on the concept. It's taken a lot of practice to get the right value of waffle into the paper. Clear and Concise is my preferred method though.
👍  
properties (23)
authorratticus
permlinkre-dreamiely-four-indicators-of-effective-technical-writing-20171214t214518163z
categorywriting
json_metadata{"tags":["writing"],"app":"steemit/0.1"}
created2017-12-14 21:45:18
last_update2017-12-14 21:45:18
depth1
children1
last_payout2017-12-21 21:45:18
cashout_time1969-12-31 23:59:59
total_payout_value0.104 HBD
curator_payout_value0.034 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length216
author_reputation5,793,669,654,286
root_title"Four Indicators of Effective Technical Writing"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id23,544,747
net_rshares23,112,433,938
author_curate_reward""
vote details (1)
@dreamiely ·
Agree! Prepping prior the actual content creation may help also. Extensive research works wonders. I find that making an outline with sub-topics, with notations on what to be discussed on these helps to keep the thoughts flowing.
👍  
properties (23)
authordreamiely
permlinkre-ratticus-re-dreamiely-four-indicators-of-effective-technical-writing-20171215t022101900z
categorywriting
json_metadata{"tags":["writing"],"app":"steemit/0.1"}
created2017-12-15 02:21:03
last_update2017-12-15 02:21:03
depth2
children0
last_payout2017-12-22 02:21:03
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length229
author_reputation16,743,022,599,252
root_title"Four Indicators of Effective Technical Writing"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id23,565,827
net_rshares1,707,888,747
author_curate_reward""
vote details (1)
@st3llar ·
$0.13
Thanks for writing about this! Writing in itself is already tough, making it technical could be pain ful at times. 

Werpa! XD
👍  
properties (23)
authorst3llar
permlinkre-dreamiely-20171215t72149468z
categorywriting
json_metadata{"tags":["writing","sndbox","philippines","steemph","thealliance"],"app":"esteem/1.5.0","format":"markdown+html","community":"esteem"}
created2017-12-14 23:21:54
last_update2017-12-14 23:21:54
depth1
children1
last_payout2017-12-21 23:21:54
cashout_time1969-12-31 23:59:59
total_payout_value0.100 HBD
curator_payout_value0.034 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length126
author_reputation6,226,336,426,581
root_title"Four Indicators of Effective Technical Writing"
beneficiaries
0.
accountesteemapp
weight500
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id23,552,546
net_rshares22,736,622,004
author_curate_reward""
vote details (1)
@dreamiely ·
Para sa ekonomiya bes. Haha
properties (22)
authordreamiely
permlinkre-st3llar-re-dreamiely-20171215t72149468z-20171215t022129586z
categorywriting
json_metadata{"tags":["writing"],"app":"steemit/0.1"}
created2017-12-15 02:21:33
last_update2017-12-15 02:21:33
depth2
children0
last_payout2017-12-22 02:21:33
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length27
author_reputation16,743,022,599,252
root_title"Four Indicators of Effective Technical Writing"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id23,565,860
net_rshares0