Improving the quality of technical writing

As a new technical editor, your supervisor has requested that you write a letter of introduction to the company that will be used as a formal introduction to the team of engineers with whom you will be working. In your letter of introduction, state four major points that you feel are important to your success as a technical editor. Remember that you will be working with to import the writing and research of the team in preparation for publication. Make up a company name, address, phone number, and any other information necessary to create a complete introduction letter including proper formatting.
Please submit your assignment.


Aspire Network Solutions
R135, Grove Central Avenue, 45208
Pleasanton, California.
Fax  321-547-654
Phone  1-432-876-765

Hello,
I have recently been appointed as a technical writer in the Aspire Network Solutions to help assist the Research and Development efforts of the company by technical writings so that these could be brought into the shape of a research paper and later be patented. Before joining the company I deeply studied the research and development that is being taken place in the company and I am very much appreciative of the work. For the past 7 years I have been involved in writing and editing technical documents and there are several papers of international repute on my credit.
For the mutual benefit I would suggest you to include the following whenever you are documenting your RD results. These recommendations usually bring the best out and turn to become good quality papers.

Graphs
Try to use graphs to enhance your result for example, if you are evaluating the power consumption of a certain type of devices such as processors than try to show it using a graph, mentioning and comparing that how much energy is consumed by each processor. Graphs are always better than Tabulated results.

Simulator
Whatever simulator you use to simulate the results before actually doing the project for example you are designing a circuit and you simulated the problem on OrCAD then try to include some details of it, parameters , limitations , optional features etc because it improves the quality of the paper. (Fletcher, 1996)

Picture
Take picture of the hardware setup or the screen shots of the simulator results to improve the quality of the work this gives a visual effect to the reader because after looking at the setup they might be able to redo the experiment easily.

Units
Please always include the units while documenting your work, you might be familiar with the units but I might not be able to understand those at all.

Details
Always include the minute details like how was the simulator setup , how were the reading taken , why was a particular step in an experimental work was causing problem , how did you improve the algorithm etc. because in the long run this would become useful , in describing and explaining some aspect of the work.

All these above recommendations would help me to organize the project report into a research paper to be published in leading computing journals such as ACM. As a note I would like to mention that these are not my requirements but are usually required by the paper reviewers.
Thank you and I wish a very cordial relationship in future with you, if you have any question feel free to email me.

David Cabrejos
Technical Writer

0 comments:

Post a Comment