Types of Technical Documentation

Types of Technical Documentation 1. Memoranda a. Brief, informal reports used to established a record b. Generalize the communication process by transmitting the message from one or more authors to one or more recipients 2. Agenda c. Is a simple list of topics to be discussed d. Helps focus a meeting on a core topics/ 3. Minutes e. Minutes of meetings both formal, informal 4. Literature Review f. Summarize existing printed or electronic information on a specific subject in a literature review 5. Reports g. Standard documents in all organization h. Stand-alone documents that relays the results of a factual inquiry i. Example 1. Laboratory Reports 2. Research Reports 3. Research Articles 4. Feasibility Reports 5. Progress Report 6. Letter i. Used to communicate to individuals or outside the organization ii. Example 6. Job Application 7. Acceptance 8. Transmittal 9. Inquiry 10. Recommendation 7. Proposals j. Identifies a specific problem and how to solve the problem 8. Press Releases k. Announces the development of a new product l. Audience consists of writers and editors of the journals iii. Elements 11. Headline 12. Lead Paragraph 13. Graphic 14. Description of the Product 15. Explanation of why the Product is important 16. Information about whom to contact

9. Specifications m. Could be a plan for: iv. Manufactured implement such as telephone v. Computer program vi. Commercial contract n. Describe the structure, parts, performance, packaging, and delivery of an object or process in detail 10. Documentation o. Final description of a system or a technical