Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleSections
Section
titleDescription

Provide an overview over the information on this document. Readers may decide on this description if the document contains relevant information to them.

Section
titleSummary

Provide a summary of the documents structure and key points. This is an informative abstract typically of about 100 to 200 words.

Source: arc42 on GitHub

More help to document quality goals in this overview is found on arc42 on GitHub.

Section
titleTechnical Constraints

List all technical constraints in this section. This category covers hardware and software infrastructure, applied technologies (operating systems, middleware, databases, programming languages, ...).

Expand
titleExpand for detailed information from https://github.com/arc42
Tip Box
titleUsing projectdoc

Typically you add documents of type Project Constraint to the homepage of constraints and then reference all technical constrains with the Display Table Macro.

You may also create a Section document and attach this section as a child to this document. Section documents share the lifespan of the parent and are removed with them. If you use a section document, the requirement overview may be easier to reference if requested. The document can be edited independently of other information. Typically is depends on the amount of information specified, if a separate document is advisable.

Source:

More help to document quality goals in this overview is found on arc42 on GitHub.

Section
titleOrganizational Constraints

List all organizational, structural, and resource-related constraints. This category also covers standards and legal constraints that you must comply with.

Expand
titleExpand for detailed information from https://github.com/arc42
Tip Box
titleUsing projectdoc
Use the Project Constraint similar as shown for the technical constraints. Use the constraint type to select in your query.
Source: More help to document quality goals in this overview is found on arc42 on GitHub.
Section
titleConventions

List all conventions that are relevant for the development of your software architecture.

Expand
titleExpand for detailed information from https://github.com/arc42
Note Box

Currently there is no doctype for conventions publicly available. It will be part of the Doctypes for Teamwork.

You may use the Project Constraint doctype or create your own.

Transclusion
documentDocument Sections
idsstandard-sections-bottom

...