projectdoc Toolbox

Doctypes and macros for documenting software projects and their artifacts.

Documents

The following documents are tagged with this tag.

Name Short Description Doctype
The first chapter of the arc42 Template with information on requirements, quality goals, and stakeholders.
The second chapter of the arc42 Template with information on constraints and conventions.
The third chapter of the arc42 Template with information on context and external interfaces.
The fourth chapter of the arc42 Template explains the solution idea.
The fifth chapter of the arc42 Template with information on the local building blocks, and their dependencies and relationships.
The sixth chapter of the arc42 Template with runtime information about the architecture.
The seventh chapter of the arc42 Template with information about how the system is deployed.
The eighth chapter of the arc42 Template with conceptional information about the system.
The ninth chapter of the arc42 Template that explains the architecture decisions that led to the system.
The tenth chapter of the arc42 Template that lists scenarios to systematically evaluate the architecture against the quality requirements.
The eleventh chapter of the arc42 Template lists risks and technical debt.
The last chapter of the arc42 Template lists terms of the domain and explains them.
Allows to select the type of an actor.
The blueprint of the arc42 Template creates a tree of pages in the Confluence space.
Document a possible option for an architecture decision. Choose this document type to describe the alternative for a decision in more detail. This is typically a subpage of an architecture decision document.
Group architecture alternatives by their type.
Document an aspect of your architecture. Something orthogonal or cross-functional like logging, exception handling or configurability.
Group architecture aspects by their type.
Document a architecture decision for an option. This is useful to state the reasons and the options that have been evaluated. Later other team members will have it easier to understand the decision.
Architecture decisions are group by their types. A commonly used decision type is 'Architecture'.
Document requirements you impose on artifacts. Artifacts are created by processes defined and used by the team. This includes assemblies created by the build process, source code artifacts or reports.
Artifact types categorize artifacts.
Describe as a Blackbox the elements of a view where only the externally visible properties are relevant.
Group blackboxes by their type.
Describe the codes that are part of the product's API.
Code types categorize codes, used in logging or exception handling.
Allows to select the type of communication between two entities.
Components are part of a view on a system. A component may refer to a enclosed element or to a complete system of its own.
Component types categorize components.
Document logical or physical groups of nodes.
Type of an environment used by the project to deploy the application or the solution.
Documents a feature of the product. The top features define the main aspects of the product.
Allows to select the importance of a feature.
Feature types categorize features.
There is no one-size-fits-all for documenting software projects. What we do is giving you an introduction on how to get started with the projectdoc Toolbox and the Software Development Add-on to define your documentation requirements with Confluence.
Interfaces document how elements of the system communicate with elements of this and other systems.
Group interfaces by their type.
Nodes are part of environments where artifacts are deployed to.
Node types categorize nodes.
Out Items record topics that are out of the scope of the project. This is useful for project inception and for reference in the future.
Out item types categorize out items.
Project Constraints limit the options of a project.
Project constraint types categorize project constraints.
Allows to select the type of a project constraint.
Frame the vision for a project or iteration.
Types to categorize vision statements for projects.
Properties are part of the configuration options of a system.
Property types categorize properties of products, such as parameters or configuration options.
Qualities describe desired aspects of the product.
Quality Scenarios document required qualities.
Quality scenario types categorize quality scenarios.
Allows to select the type of a quality scenario.
Documents a quality target for a product.
Group quality targets by their type.
Documents requirements of a product.
Categorization of requirements for a product.
Technical Debts track issues to be paid back.
Allows to select the quality type of technical debt.
Technical Debts are grouped by the area they address.
Document a test case of your project.
Test case types categorize test cases.
Defines a charter to run an exploratory test session.
Test charter types categorize test charters.
Document data used for test cases.
Test data types categorize test data.
Documents the results of a test session for the sponsoring stakeholders.
Test report types categorize test reports.
Defines a document to collect information during a test session.
Test session types categorize test sessions.
Overview over the most relevant information for software developers to create their documentation on Confluence with the projectdoc Toolbox.
Defines a use case of the product.
Allows to select the level of an use case.
Use case types categorize use cases.
User Characters are the actors of user stories. They include personas and extreme characters.
User character types categorize user characters.
Allows to select the type of an user character.
Different views on the product help to document the system and its architecture. Typical views are building block, runtime, or deployment.
Groups the views at a system.
Allows to select the type of a vision statement.
Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant.
Group whiteboxes by their type.