Documentation on the system. This is the internal view on the product for the development team.
Doctypes of this Type
Name | Short Description |
---|---|
Applications provided functions required by services. Applications may be hosted on one or more systems. |
|
The blueprint of the arc42 Template creates a tree of pages in the Confluence space. |
|
Document an aspect of your architecture. Something orthogonal or cross-functional like logging, exception handling or configurability. |
|
Associates two documents. |
|
Describe as a Blackbox the elements of a view where only the externally visible properties are relevant. |
|
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. |
|
Configuration items (CIs) may be (sub-)systems or components. Whatever may change and needs to be tracked may be documented as a CI. |
|
Datasets are used as the input and output of processes. |
|
Excerpts are abstracts of information found in a resource, such as a book. If you want to go into more detail for a given resource, there may be multiple excerpts as subpages of the resource document. |
|
FAQs help to record an answer to a frequently asked question concerning the project, the product, the system or the process. |
|
Generic Documents provide information where no other doctype matches. |
|
Interfaces document how elements of the system communicate with elements of this and other systems. |
|
IT Activities define activities for processes. |
|
IT Assets define assets required or produced by processes. |
|
IT Procedures define procedures for processes. |
|
Processes organize activities to create a defined business value. |
|
IT Services provide business relevant services for customers. |
|
Systems are part of environments where products are deployed to. |
|
Locations provide information about the whereabouts of assets, configuration items, and systems. |
|
A documentation module is a fragment which is usually transcluded by other documents. The lifetime of a module document is independent of the lifetimes of the documents that reference it. |
|
Patterns provide solutions for problems in a given context. Patterns are usefull in multiple areas such as design, architecture, documentation, or process. |
|
Impacts define how the results of processes affect the world. |
|
Outcomes define the results of processes. |
|
Profiles provide views on documents via delegation. |
|
Quality Scenarios document required qualities. |
|
Quality scenario types categorize quality scenarios. |
|
Releases document the changes that are applied to a published version of a service. |
|
Sections of a document are typically part of a document. But the size of sections may vary. To support a team to write collaboratively on the documentation, a larger document may be subdivided into external section documents. |
|
Announcements communicate with stakeholders information about a service. |
|
Compile other documents, yet space indices are themselves projectdoc documents. So they can be tagged and grouped. |
|
Describes a single step of an activity. A step is a generic document that is associated with a document that describes a process. It may be a test log or a howto. |
|
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. |
|
A description of a given topic. A topic may describing or explaining a concept, a task to accomplish or a reference. There are a couple of topic types that set the expectations for the reader. Instances of the topic doctype usually have independent lifetimes from any referencing documents. |
|
Guided tours through existing information. This allows to aggregate topics for a given question or audience, thus providing a view on a topic. |
|
Triggers define signals for activities and processes. |
|
Defines a use case of the product. |
|
Use case types categorize use cases. |
|
User character types categorize user characters. |
|
Different views on the product help to document the system and its architecture. Typical views are building block, runtime, or deployment. |
|
Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant. |
|
Work Instructions define procedures for processes. Provide the most detailed information here how tasks are to be executed. This includes best practices. |