199100-19171, 99100-19171, rajeevjain72@gmail.comrajeevjain72@gmail.com

C2C:Campus2Corporate rajeevjain72@gmail.comC2C:Campus2Corporate rajeevjain72@gmail.com

Engg Documentation at various stages of SDLC

◦ Requirement (PRD, SRS, FRS)◦ Architecture Docs

Design, Implementation, and Deployment◦ Test case, Process Docs, Induction (engg)◦ Pre-Release Notes, Engg Release Notes◦ API Guides, Developers Guide, Cookbook◦ Coding Guidelines, Naming conventions◦ DFDs, Data Models, E/R diagram◦ FAQs, Knowledgebase, Abbreviation, and Key Terms◦ Platform and porting guide, Service manuals◦ Application Note, Technical Article, White paper◦ Reports, Meeting Minutes, Emails, Policy and Process document◦ List of errors (internal Vs external), Your own list….

C2C:Campus2Corporate rajeevjain72@gmail.comC2C:Campus2Corporate rajeevjain72@gmail.com

Key Challenges Time constraint Limited Resources Hard to find technical writers for this task Documentation time not logged Not part of project planning Priority is always delivery/release

C2C:Campus2Corporate rajeevjain72@gmail.comC2C:Campus2Corporate rajeevjain72@gmail.com

◦ Before Writing Purpose of writing Pre-requisite and Assumptions Doc Estimation (with release timelines) Sign-Off and Publishing (Releasing) Process

◦ DDLC (for internal documents) Architecture, Product , SRS, PRD, SFS, Design Docs, Data Architecture,

Release Notes, ERDs, and others (with examples) Induction and Knowledge Transfer documents

◦ Code Commenting◦ Document Structure

Key Sections Self explanatory headings Using Lists, Tables, Figure, TOC Look and Feel; Understanding Stakeholders

C2C:Campus2Corporate rajeevjain72@gmail.comC2C:Campus2Corporate rajeevjain72@gmail.com

◦ Finding/Tracking Documentation Time Focus on Agile Methodology

◦ Establishing Review and Sign-Off process◦ Tips and Best Practices◦ Do’s and Don'ts ◦ Language Basics◦ Exercise

C2C:Campus2Corporate rajeevjain72@gmail.comC2C:Campus2Corporate rajeevjain72@gmail.com

20+ years of IT experience Worked as

◦ Program Manager, System Analyst, and Programmer◦ Technical Publication Manager, API/SDK Writer

Hired, trained, and managed global teams Moderator:

◦ APIWriters (Yahoo group)◦ C2C:Campus2Corporate (Google group)

Published Titles: Y2K and India, IP (CBSE) Bridging Academia-Corporate gap Promoting Technical Writing profession Free help for Intern/Fresher hiring FB/Linkedin: rajeevjain72

C2C:Campus2Corporate rajeevjain72@gmail.comC2C:Campus2Corporate rajeevjain72@gmail.com

C2C:Campus2Corporate rajeevjain72@gmail.comC2C:Campus2Corporate rajeevjain72@gmail.com

C2C:Campus2Corporate rajeevjain72@gmail.comC2C:Campus2Corporate rajeevjain72@gmail.com

◦ Narayan Murthy and Y S Rajan, for my first book titled “Y2K and India”◦ P Rajendran, for my efforts to bridge Academia-Corporate gap◦ Listed among the “Top 400 Most Influential in #Techcomm and

#ContentStrategy”◦ Mentor of STC-India (Society of Technical Communication)◦ Presented papers at STC-India Annual Conferences of 2004, 2006,

2009-2011◦ Judge for Thinkquest competition (An Oracle initiative)◦ Won many innovation and performance based awards◦ 100+ workshops, webinars, and trainings on Technical Documentaion◦ Volunteer: Ashoka, iVolunteer, READ, Bill-Melinda Gates Foundation

C2C:Campus2Corporate rajeevjain72@gmail.comC2C:Campus2Corporate rajeevjain72@gmail.com

◦Professional Business/Email Communication◦Agile: Methodology, user stories, JIRA◦Managing Your Bosses/stakeholders 9-2-6 Global Teams Multiple Programs Last Minute Updates

◦Art of Negotiation (for IT teams)◦Art of Mentoring (focus “Mentoring at office”)◦Proposal Writing◦C2C:Campus2Corporate for Fresher

Questions and Comments?

-Rajeev Jain9910019171

rajeevjain72@gmail.comLinkedin: www.linkedin.com/in/rajeevjain72

Facebook: www.facebook.com/rajeevjain72

11