You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

projectdoc Toolbox

Doctypes and macros for documenting software projects and their artifacts.

Name
Software Development

Documents

The following documents are tagged with this tag.

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