BossaBox

This is the playbook for engineering-playbook

Documentation

Every software development project requires documentation. Agile Software Development values working software over comprehensive documentation. Still, projects should include the key information needed to understand the development and the use of the generated software.

Documentation shouldn’t be an afterthought. Different written documents and materials should be created during the whole life cycle of the project, as per the project needs.

Table of Contents

Goals

Challenges

When working in an engineering project, we typically encounter one or more of these challenges related to documentation (including some examples):

What documentation should exist

Best practices

Tools

Recipes

Resources