#Software Development

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.
doctype
The second chapter of the arc42 Template with information on constraints and conventions.
doctype
The third chapter of the arc42 Template with information on context and external interfaces.
doctype
The fourth chapter of the arc42 Template explains the solution idea.
doctype
The fifth chapter of the arc42 Template with information on the local building blocks, and their dependencies and relationships.
doctype
The sixth chapter of the arc42 Template with runtime information about the architecture.
doctype
The seventh chapter of the arc42 Template with information about how the system is deployed.
doctype
The eighth chapter of the arc42 Template with conceptional information about the system.
doctype
The ninth chapter of the arc42 Template that explains the architecture decisions that led to the system.
doctype
The tenth chapter of the arc42 Template that lists scenarios to systematically evaluate the architecture against the quality requirements.
doctype
The eleventh chapter of the arc42 Template lists risks and technical debt.
doctype
The last chapter of the arc42 Template lists terms of the domain and explains them.
doctype
Allows to select the type of an actor.
macro
The blueprint of the arc42 Template creates a tree of pages in the Confluence space.
doctype
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.
doctype
Group architecture alternatives by their type.
doctype
Document an aspect of your architecture. Something orthogonal or cross-functional like logging, exception handling or configurability.
doctype
Group architecture aspects by their type.
doctype
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.
doctype
Architecture decisions are group by their types. A commonly used decision type is 'Architecture'.
doctype
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.
doctype
Artifact types categorize artifacts.
doctype
Describe as a Blackbox the elements of a view where only the externally visible properties are relevant.
doctype
Group blackboxes by their type.
doctype
Describe the codes that are part of the product's API.
doctype
Code types categorize codes, used in logging or exception handling.
doctype
Allows to select the type of communication between two entities.
macro
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.
doctype
Component types categorize components.
doctype
Data type types categorize data types.
doctype
Document logical or physical groups of nodes.
doctype
Type of an environment used by the project to deploy the application or the solution.
doctype
Documents a feature of the product. The top features define the main aspects of the product.
doctype
Allows to select the importance of a feature.
macro
Feature types categorize features.
doctype
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.
topic
Interfaces document how elements of the system communicate with elements of this and other systems.
doctype
Group interfaces by their type.
doctype
Nodes are part of environments where artifacts are deployed to.
doctype
Node types categorize nodes.
doctype
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.
doctype
Out item types categorize out items.
doctype
Project Constraints limit the options of a project.
doctype
Project constraint types categorize project constraints.
doctype
Allows to select the type of a project constraint.
macro
Frame the vision for a project or iteration.
doctype
Types to categorize vision statements for projects.
doctype
Properties are part of the configuration options of a system.
doctype
Property types categorize properties of products, such as parameters or configuration options.
doctype
Qualities describe desired aspects of the product.
doctype
Quality Scenarios document required qualities.
doctype
Quality scenario types categorize quality scenarios.
doctype
Allows to select the type of a quality scenario.
macro
Documents a quality target for a product.
doctype
Group quality targets by their type.
doctype
Documents requirements of a product.
doctype
Categorization of requirements for a product.
doctype
Technical Debts track issues to be paid back.
doctype
Allows to select the quality type of technical debt.
macro
Technical Debts are grouped by the area they address.
doctype
Document a test case of your project.
doctype
Test case types categorize test cases.
doctype
Defines a charter to run an exploratory test session.
doctype
Test charter types categorize test charters.
doctype
Document data used for test cases.
doctype
Test data types categorize test data.
doctype
Documents the results of a test session for the sponsoring stakeholders.
doctype
Test report types categorize test reports.
doctype
Defines a document to collect information during a test session.
doctype
Test session types categorize test sessions.
doctype
Overview over the most relevant information for software developers to create their documentation on Confluence with the projectdoc Toolbox.
tour
Defines a use case of the product.
doctype
Allows to select the level of an use case.
macro
Use case types categorize use cases.
doctype
User Characters are the actors of user stories. They include personas and extreme characters.
doctype
User character types categorize user characters.
doctype
Allows to select the type of an user character.
macro
Different views on the product help to document the system and its architecture. Typical views are building block, runtime, or deployment.
doctype
Groups the views at a system.
doctype
Allows to select the type of a vision statement.
macro
Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant.
doctype
Group whiteboxes by their type.
doctype