Agile documentation development methodology Giby Panicker and Judith

Agenda • Software Engineering Process Models • Waterfall vs Agile-a comparison • Agile evolution and principles • Scrum - an Agile method • Agile Best Practices • Benefits of working in Agile 2 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Software Engineering Process Models • Waterfall model • Spiral model • Agile development 3

Traditional Method - Waterfall model 4 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Iterative model- Agile 5 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Waterfall vs Agile Requirements Analysis Test Voice of the Time Design Implementation Customer Deployment 2 -4 weeks iteration Requirements Deployment Time Agile method Waterfall flow 6 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Waterfall and Agile - a comparison Waterfall Agile Long detailed plan Short term plan Customer feedback at the end of the cycle. Constant feedback from the customers Less customer satisfaction Better customer satisfaction through early and continuous delivery of valuable software and meeting the right expectation High risk to change in requirement Adapt to change in requirement to address the issues promptly Predictable software Working software in shorter timescale Highly risky, often more costly and generally less efficient Less risky, low cost and more efficient 7 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Agile Evolution Individuals and interactions over processes and tools Working software over comprehensive documentation Customer collaboration over contract negotiation Responding to change over following a plan Moving quickly and lightly 8 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Principles of Manifesto Satisy the customer Early and continuous delivery of working software Change in requirements Adapting to change even late in the cycle Deliver working software frequently Deliver fully tested working software with 2 -4 weeks iteration Work together daily Work together throughout the project Work around motivated individuals Build projects around motivated individuals and motivate them Face-to-face conversation The most efficient and effective method of conveying information to and within a team 9 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Principles of Manifesto (contd…) Working software is the primary measure of progress Sustainable development Promote sustainable development. Maintain constant pace. Continuous attention to technical excellence Simplicity is essential Self organizing teams Scrum teams Tunes and adjusts to the product behavior The team reflects on how to become more effective, then tunes and adjusts its behavior accordingly 10 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Crystal Lean DSDM Scrum XP Kanban FDD Agile - Many methods 11 COPYRIGHT ©

Scrum- an Agile method Product Owner Product Backlog 12 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL

Agile http: //www. youtube. com/watch? v=n. Vd. Scd 4 m-x 8 13 COPYRIGHT ©

Agile Documentation Best Practices R Planning The techniques and documentation deliverables are well suited for documenting products developed in agile environment. E L Documentation E A Verification S E 14 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Planning Best Practices Plan it well Use the right tool • Estimate the features • Consult the development team • Answer standard questions • Conduct a doc planning poker session • Collaborate on estimates with other writers • Reduce rework • Get access to the same planning tool that the Agile development team is using • JIRA, Rally or XPlanner • Documentation, development and QA tasks. 15 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Planning Best Practices Manage your tasks • Create documentation tasks • House all documentation stories in “Tech Pubs Documentation” • Create “Tech Pubs Overhead” component to log overhead tasks • Clarify on the number of iterations the documentation can be completed after the development team’s completion of the feature Adapt right methodologies • Topic-oriented writing is authoring concise, self-contained units of information about a specific topic • Use a topic-oriented approach such as the Darwin Information Typing Architecture (DITA) or Information Mapping. TM • Using Information Mapping and DITA enables to produce right documentation at the right time 16 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Documentation Best Practices Prioritize Focus on content • Work on high-priority, low risk items • Return to lower-priority or higher-risk items • Aligning to feature priorities • Convert user stories to task-oriented topics • Task-oriented writing complements development’s use of user stories • Task-oriented writing is a necessity given the short iteration cycle and often limited number of writing resources • Helps writers achieve minimalism 17 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Verification Best Practices Collaborate • For each task, ask the QA team to create an equivalent task for reviewing • Request a “hardening” iteration • Establish processes such as verification process, peer writer install process, peer review process etc. • Cross-functional review Communicate • Face-to-face communication • Attend daily stand up meetings, sprint meetings, demos etc • For teams that are not co-located find ways to communicate as personally as possible in real-time: • Instant Messaging • Web cameras with video conferencing 18 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.

Working Together as a Team Planning Documentation Verification planning poker session prioritize the doc tasks access to feature tracking tool Ongoing convert Communication reduce user at rework into all phases stories topics create tasks for QA to review request for hardening iteration 19 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED. create user stories similar to product topic oriented writing establish new processes

Benefits of working in Agile • Better integration of documentation with product • Incremental development; reviews in chunks • Early feedback from users • Timely sharing and resolution of impediments in authoring • Comprehensive insight into product changes and development ü Greater teamwork ü Improved quality ü Lowered cost 20 COPYRIGHT © 2012 ALCATEL-LUCENT. ALL RIGHTS RESERVED.