Technical writing process
- 1. Technical Writing Process Prepared By: Saurabh Kaushik Dept: LIS Roll No- 6553
- 2. Contents • Introduction to technical writing • Definition • Technical Writing Process
- 3. Introduction • Technical writing can be defined as art of presenting technical information in such a way that the audience it is addressed to can understand and use the information. • It conveys specific information about a technical subject to a specific audience for a specific purpose. • It is an art of delivering technical information to a technical and non- technical user in simple and easy to understand way. • Convert complicated subject matter and transform it to easy to understand form for reader. • It is done in the workplace and centers around technical topics. • It is writing those involved in technical fields.
- 4. Definition • Markel, M defines technical writing as the process of creating , designing and transmitting technical information so that people can understand it easily and use it safely, effectively and efficiently. • Art and science of making technical information accessible, usable and relevant to a variety of audience in a variety of settings. • Michael H.Markel defines it writing that conveys specific information about a technical subject to specific audience for a specific purpose.
- 5. TECHNICAL WRITING PROCESSTECHNICAL WRITING PROCESS
- 7. Understanding Audience The audience element is so important that it is one of the cornerstones of the technical writer. You are challenged to write about highly technical subjects but in a way that a beginner-a non specialist can understand it. Educational qualification of the audience.
- 8. Gathering Information Style of writing. Type of document. Obtains information about the audience. Required resources. Based on the audience the writer gather information on the subject that is to be written.
- 9. Designing Document • Sorting of gathered information. • Creation of outline of document based on information. • Writer provides a logical structure of the document that the most important information appears first. • Essential details and examples and at last supporting information is presented. • Blueprint of the document. • Provides information about type of document.
- 10. Creating Document • Development of draft document based on the design. • Writing style should be simple. • Easy Language • Avoid technical jargons. • User friendly.
- 11. Reviewing Document • Self Review • Peer Review • Fictional Review • Technical Review • Client Review
- 12. Publishing Document • Based on users demand. • If the user want the soft copy then burn the CD/DVD of document and provide it to user. • If user wants printed format then print it properly and bind it.
- 13. Thank You