5 Essential Tips for Technical Writing

This post is summarized from the Ten Great Technical Writing Tips. Photo by Dr. Goldschmidt.

technical writing Technical writing is generally defined as the practice of writing that mostly concerns with technical artifacts such as Software or some Electronic products. This task requires the writer to have a profound knowledge of the inner working of the product itself. Even if he may not be directly related to the development of the product, he must hold a very good knowledge about the product and how it works. These people are known as knowledge workers and has a high reputed stature in the organization they have the complicity.

This article will discuss some tips which can be handy in enhancing this class of technology oriented writing.

Be Focus

Be focus on the final aim of the documentation. As you may get too much deep into the explaining the system and thus the readers become clueless after awhile. So stay on the aim of the documentation and explain with comments and other side-notes. 

Be Simple

When you explain try to keep it as simple as possible and elaborate for the sake of the user, cause users are not the system’s expert, and they reply on you to make them understand. 

Comparative

Draw up table in order to compare different groups of data, this visual way will make the points clearer. Put graphical representations also if needed. 

Proof-Reading

Proof-reading is a must. It is actually quite embarrassing to submit a copy that is full of spelling and grammatical glitches. 

Solid Reference

Provide appropriate sources and notes. Also it is better to append few pages exclusively listing the references on the subject matter.

Feel free to browse through the technical writing jobs offered in our job board.

Shvoong.com - Your Freelance Writing Job Opportunities

Shvoong.com - Your Freelance Writing Job opportunities We had received few requests on sharing more information about the place to hurt for freelance writing jobs. Shvoong.com is one of the best place to look for this kind of writing job opportunities. They are opening a door for the anyone who thinks he has the capacity to earn some money by writing reviews, summary and abstract.

The topic of writing can be anything ranging from a book, a journal or a website. The writer will write a short abstract on the subject according to the guideline. Then, submit it and get paid. The money will be transferred to the paypal account by the end of the month. The money will be calculated based on the number of hits for your written abstract. No hit, No money.

Another earning opportunities is go by translation. Anybody making a translation on the existing reviews or abstracts is entitled to receive 5% in a same Hits Calculation formula! Please take note, they only accept human-translation. Any translation from auto-translation software will be auto-detected and flag as plagiarism. Don’t try to fool with them. smile_wink

The design of the site is quite relaxing and easy going. It has a huge number of topic from which the user can choose to write. The FAQ section is pretty enriched and almost any user-query can be found there, but if not, then the user can also post his questions. Anyone who is new should have a glance at the questions answered in FAQ.

Another good thing is that the site is supported in many other language than English, thus giving a wider access to great many people around the world. The new members can have a nice little picture of them in the right side of the panel.

Over all it’s a great site to churn out some real extra cash just by writing, so anyone who thinks he is good enough to rack his brain to produce a little good summary is entitled to be rewarded. Just give a try and feedback to us whether it works for you or not.

The Best Source for Freelance Writing Jobs

This post was guest blogged by Hafshah, a freelance writer.

Working as a freelance writer is normal in USA, UK and Australia. However, freelance writing in Malaysia is still in its infant stage. However, it is slowly picking up here judging by the numerous freelance websites available on the net nowadays.

Being a freelance writer myself, the main source of getting freelance writing jobs is through the net. There are a few Websites available if you want to search for freelance writing jobs:

Malaysian Websites:

  • LowYat Forum - There are few freelance writing jobs posted there if you can find it.
  • AsiaPartTime - Not to promote ourselves,but we do have few writing jobs open for now. We also looking for freelance writer for our community blog. Check this out.
  • IAmFreelancer.com - There are few writing jobs posted there with in these few months.

International Websites:

The Writers

Poh EePoh Ee

AsiaPartTime Co-Founder
Main Blogger

Poh EeZul

Skor Career Co-Founder
Guest Blogger

AsifAsif

Guest Blogger

Want to join our team? Contact Us Now. Share your knowledge with us.

The Readers

Close
E-mail It