1 / 6

Checklist for Writing a Technical Document

Checklist for Writing a Technical Document. Outlining. Group similar items Order the items in designated groups Avoiding common logical problems Choose an outline format. Drafting . Draft right on the outline Start with the easiest topics Do not stop to gather information or to revise

zody
Download Presentation

Checklist for Writing a Technical Document

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Checklist for Writing a Technical Document

  2. Outlining • Group similar items • Order the items in designated groups • Avoiding common logical problems • Choose an outline format

  3. Drafting • Draft right on the outline • Start with the easiest topics • Do not stop to gather information or to revise • Use abbreviations

  4. Basic Patterns of Information • Chronological – time pattern • Spatial – describe objects and physical sites • General to specific • More important to less important • Comparison and contrast • Classification and partition • Problems-methods-solution • Cause and effect

  5. Types of Formal Reports • Informational report – presents facts. • Analytical report – provides information and an analysis of the information with conclusions or an interpretation of the results. • Recommendation report – presents information and an analysis of the information, plus it advocates a course of action.

More Related