1 / 11

Mastering Technical Writing in IT Projects: Bridging Communication and Technology

Discover the pivotal role of technical writing in IT projects and services, enhancing communication between humans and machines. This article discusses the importance of user advocacy, UI elements, and crafting marketing materials that effectively convey business values. Explore the challenges technical writers face, such as unclear audience and undefined standards, while leveraging unique skills to provide comprehensive and consistent information. Learn how to set writing standards, document processes, and build internal relationships to ensure quality, clarity, and effective communication in technology-driven environments.

baris
Télécharger la présentation

Mastering Technical Writing in IT Projects: Bridging Communication and Technology

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. The Magic of Technical Writing In IT Projects and Services

  2. TECHNICAL abracadabra DOCUMENTATION

  3. 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

  4. 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

  5. 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

  6. 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

  7. 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

  8. 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

  9. 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)

  10. Thanks … … and You 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

  11. Who Cares ! Questions Please

More Related