Describe the process on how to write a technical document fr

Describe the process on how to write a technical document from an idea to final draft (2 paragraphs)

Solution

To prepare the report it should go through some iterations.

Prepare first draft then review it, edit it, go through same process and then come up with final draft.

First draft-

Step 1) Concentrate on the idea. Write down the content around idea. Don’t try to correct grammar, presentation, summery or introduction at this stage. You can edit the words, grammar, phrases later once idea is on the paper. Look for the areas where you need more contain to support the idea at this stage.

Step 2) Identify the graphics required for the documentation. Or get help from someone expert in presenting with good graphic.

Review and editing-

Now at this stage focus has shifted form the contain to the clarity in conveying the thought.

Step 1) Review the draft for incompleteness, gaps, and overlaps in topics. If multiple review are involved writer should prepare the schedule for different reviewer.

Step 2) ensure that draft now comply with the required guidelines, compliances issues and cohesiveness.

Step 3) Rewrite the draft

Step 4) Collate the required graphs, table for additional information required in the appendices section.

Preparing final draft-

Final draft preparation includes formatting the document; finalizing the graphs and the tables; double-checking to ensure that all the components are included and in the proper order. Prepare the draft as per the mentioned order of contain.

Technical report should contain the following information

Title Page – It includes the title of the report. Title should clearly indicate the contain of the report.

Summary – Every person may not get enough time to read through whole report or he may be interested in knowing brief summary of the report before going through whole report.

Table – It should include headers and sub section along with the page number

Introduction – It should state the objective of the report and provide additional comment in which the report to be treated.

Sections – This separates the different ideas into various sections.

Conclusion – It should provide the short and logical theme developed from the report.

References – Details on various sources, journals referred while preparing the report.

Appendices – Any further information viz. tables, graphs, additional sources necessary for additional information for the report.