2. In IT Projects and Services The Magic of Technical Writing

3. TECHNICAL abracadabra DOCUMENTATION

4. The Magic of Technical Writing Place in the Organization We connect the human to the machine –User advocate –UI elements included –Explaining Business –Walking stick We create the image, we sell the company –Packaging of Product/project/services –Marketing Collaterals and other literature –Corporate communications, media –Web content, training material

5. The Magic of Technical Writing What Projects/Services? Software Industry –product enhancement/ dev in parts/ migration/ re-engineering/ reverse engineering: NO NEW ISSUES BPO – ITES and Help Desks Integration/ Testing Technology Services Training Services Education / Training Website / Content EVERYTHING UNDER THE SUN

6. The Magic of Technical Writing The Challenges Uncertainties –Unknown target/audience –Unclear USPs –Undefined standards and style –Line of projects/services –Varying levels of service, levels of audience –Unclear (doc) requirements –Undefined role Short supply –Invisible sources (of info) –Lack of appreciation/help –Shorter time to market Hence More Work Load

7. The Magic of Technical Writing Advantage TW Unlimited Opportunity Make Your Own Role Unique Skills –Communication Skills –Editing Support –Review of Documents –Knowledge Management –Content Development Wider Exposure –Styles, standards and templates –Domain knowledge –Internet

8. The Magic of Technical Writing Set Standards Holistic Information –Quality of English: change customer perceptions –Help your company get and provide Complete and Consistent information Styles and Rules –Set writing standards, style rules –Publish them, apply them Document Processes –Develop Checklists –Evangelize Quality & Clarity –Bring rigor(thoroughness) into content Customer Orientation

9. The Magic of Technical Writing You are the Selling Proposition Tech Writing Services –Can be a useful entry point –Can build relationships –Cognizant experience –Independent module Participate –Build internal relationships –Sell your services –Learn from them –Offer Training –Foreign languages

10. The Magic of Technical Writing Document to the Question* (a few points from Bonnie’s STC presentation) Elicit questions from diverse contacts Anticipate and preempt questions * (Apologies to Bonnie Graham)

11. The Magic of Technical Writing … and You Thanks … To Satyam Computer Services Ltd. Richard Dimock, Dave Fields, and Leonard Koff, peers in NCR Corporation John Robert Cornell, peer in DST Innovis All the ‘tech’ colleagues

12. The Magic of Technical Writing Questions Please Who Cares !