To document a software project does not only require the systems or architecture documentation. In Software Architecture Documentation we list the four quadrants:
Process Documentation
Project Documentation
System Documentation
User Documentation
Here are some more examples on how to use the PDAC1 to provide project relevant information.
Column
Section
title
Facilitate Team Communication
Section
title
Developer Journals
Developers may keep journals to track open questions and interesting findings. These journals may be open for all team members to find relevant information on project topics.
Note Box
This information is part of the project quadrant (Q2)
Section
title
Team Journals
Besides the individual journals the team may write a team journal to plan and run iterations or sprints. The Doctypes for Agile Planning provide templates for these communication needs.
Note Box
This information is part of the project quadrant (Q2)
Section
title
Teamwork
Use Doctypes for Teamwork to define checklists, processes, patterns, tools, and rules a team agrees upon. Writing them down makes them accessible for anyone - especially for new team members. Keep these documents short and to the point!
Note Box
This information is part of the process quadrant (Q1)
Section
title
Project Management
Doctypes for Project Management provides tools to communicate important project information with decisions, risks, open issues, and meeting minutes.
Note Box
This information is part of the project quadrant (Q2)
Section
title
Domain Knowledge
Section
title
Glossary
A glossary is helpful for most project and product documentations.
Note Box
Dependent on the intended audience this information is part of the product quadrant (Q3, for users) or system quadrant (Q4, for the team working on the product).
Section
title
Project Library
A project library collects relevant information for the project that is typically provided by external resources. These resources include books, website, blogs, or articles. The library is especially helpful to provide information about the domain or technology stack for new team members.
Note Box
This information is usually part of the system quadrant (Q4)
Section
title
Domain Space
In order to create a glossary the team may need to do some domain crunching. Create a separate space to collect all information relevant for the domain.
Add things you learned about the domain that should be accessible beyond the scope of the current iteration or sprint of your team.
Note Box
As long as the domain is explored, the this information is part of a workspace that is not part of any quadrant. For the information that is relevant in the future, the topic space may be part of the product quadrant (Q3, for users) or system quadrant (Q4, for the team working on the product) dependent on the intended audience.
Section
title
Stakeholder Communication
Different stakeholders have different information and communication needs.
This information, once moved to a topic space, is either part of the system quadrant (Q4), if the stakeholder is a team member), or of the product quadrant (Q3), if the stakeholder is a user.
projectdoc-section
title
User Documentation
Products, especially technical products with powerful or complex interfaces, need documentation for their users.
Section
title
Plugin for Maven
Teams whose builds depend on Maven and that use automation heavily typically end up in writing their own plugins for Maven. Although these plugins are often only released for internal use, developers who employ these plugins need to have access to proper documentation.
Note Box
This information is part of the product quadrant (Q3)
Section
title
Library for Java
Teams using continuous deployment may choose to create libraries to modularize their code base. Each library is a product of its own with its own release cycle. Especially if the library is made public available, a sound and similar structure of the documentation helps developers to find information on how to use this library easily.
Note Box
This information is part of the product quadrant (Q3)