Documentation

Creating documentation to describe the software and its use.

Also Known As

Guides
Manuals
Technical Writing

Addresses / Mitigates

Invisibility Risk: Makes all aspects of the project transparent and accessible to the team.
Communication Risk: Provides clear guidelines and information, reducing misunderstandings.
Learning Curve Risk: Detailed documentation helps manage and understand complex systems.

Attendant Risks

Schedule Risk: Creating and maintaining documentation can be time-consuming.
Complexity Risk: Extensive documentation can sometimes add to complexity rather than simplifying it.
Implementation Risk: Poorly documentation can lead to implementation issues in development.

Used By

Extreme Programming: XP values communication, which can include necessary documentation, but prioritizes working software and direct communication.
Scrum: Documentation is produced, but Scrum values working software over comprehensive documentation.
Waterfall Development: Detailed documentation is created and maintained throughout each phase in Waterfall to ensure clarity and traceability.

Description

"Documentation is any communicable material that is used to describe, explain, or instruct regarding some attributes of an object, system or procedure, such as its parts, assembly, installation, maintenance and use." - Documentation, Wikipedia

Documentation in software development provides a detailed description of the software, its components, and its usage. It serves as a vital reference for developers, users, and stakeholders, helping to ensure that everyone has a clear understanding of the system. High-quality documentation is essential for effective communication, troubleshooting, and future development.