Agile Software Documentation: Types, Importance, and Tools, Study Guides, Projects, Research of Computer Science

Download Agile Software Documentation: Types, Importance, and Tools and more Study Guides, Projects, Research Computer Science in PDF only on Docsity!

Agile Software Documentation

Software Documentation

Why is documentation necessary for Agile

development?

 The main purpose of documentation is to communicate  Necessary to define the target audience before embarking on documentation  Comprehensive documentation does not ensure project success  In the process of development, time spent on documentation is time not spent writing code  Documentation serves different needs during and after development

Who should perform documentation and when?

 Everyone  Each person should be responsible for documenting their code  Comments and a reference manual have different goals  Documentation should be just-in-time  Document only when code is stable  Out of sync documentation is useless  Documentation should be evolutionary  Documentation should be concise: overview/roadmaps  Benefit of having documentation should be greater than the cost of creating and maintaining documents

What types of documents to create?

 Project Overview  Management  Requirements  Design  Operations  Support  User

Project Overview Document

 For Developers, Managers, Maintenance Developers, Operations Staff  A summary of critical information such as the vision for the system, primary user contacts, technologies and tools used to build the system, and the critical operating processes (some applicable to development, such as how to build the system and some applicable to production, such as how to back up data storage). Also provides references to critical project artifacts such as the source code (the project name in the source code control system is often sufficient), where the permanent models pertaining to the system (if any) are, and where other documents (if any) are Copyright Scott W. Ambler

Requirements Document

 For Developers, Maintenance Developers, Users, User Managers  This document defines what the system does, summarizing or composed of requirements artifacts such as business rule definitions, use cases, user stories, or essential user interface prototypes  Under XP, in forms of User Stories and CRC cards Copyright Scott W. Ambler

System and Design Document

 For Developers, Maintenance Developers, Project Managers  A summary of critical decisions pertaining to design and architecture that the team made throughout development  The purpose of this document is to provide an overview of the system and to help people understand the system. Common information in this document includes an overview of the technical architecture, the business architecture, and the high- level requirements for the system. Detailed architecture and design models, or references to them, may also be included where appropriate Copyright Scott W. Ambler

References and Recommended Reading  www.agilealliance.com  www.agilemodeling.com  www.agiledata.org  www.ambysoft.com  www.databaserefactoring.com  www.enterpriseunifiedprocess.com  www.controlchaos.com  Extreme Programming: A Gentle Introduction www.extremeprogramming.org