Date: Fri, 29 Mar 2024 12:23:02 +0100 (CET) Message-ID: <1296087662.17940.1711711382257@09e9d69a2016> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_17939_1615900558.1711711382257" ------=_Part_17939_1615900558.1711711382257 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The second chapter of the= arc42 Template with information on constraints and conventions.
Lists any requirement that constra= ins software architects in their freedom of design decisions or the develop= ment process.
This is the second chapter of the arc42 Template.
The document type swad-section provides the following propertie= s:
Please note that only information about specific properties is provided = here. Common document property used by all document types are documented by= Document Propert= ies.
The subtype of the document type identifies the document instance within=
its swad-section
doctype.
Provide an overview over the information on this document. Readers may d= ecide on this description if the document contains relevant information to = them.
Provide a summary of the documents structure and key points. This is an = informative abstract typically of about 100 to 200 words.
List all technical constraints in this section. This category covers har= dware and software infrastructure, applied technologies (operating systems,= middleware, databases, programming languages, ...).
More help to document quality goals in this overview is found on docs.arc42.org.
Using projectdoc
Typically you add documents of type Project Constraint to the homepage of constra= ints and then reference all technical constrains with the Display Table Macro.
You may also create a Sect= ion document and attach this section as a child to this document. Secti= on 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 refe= rence if requested. The document can be edited independently of other infor= mation. Typically is depends on the amount of information specified, if a s= eparate document is advisable.
List all organizational, structural, and resource-related constraints. T= his category also covers standards and legal constraints that you must comp= ly with.
More help to document quality goals in this overview is found on&n= bsp; docs.arc42.org .
Using projectdoc
List all conventions that are relevant for the development of your softw= are architecture.
More help to document quality goals in this overview is found on docs.arc42.org .
Currently there is no doctype for conventions publicly available. It wil= l be part of the Doctypes for Teamwork.
You may use the Project Constraint doctype or create your own.
These are internal notes that are usually not exported and only visible = to team members with write access.
But this is not a safe place to store sensible informat= ion. It is just a convenience for the reader to not be bothered with notes = stored here for the authors for later use. The security level is about supp= ressing the representation by a CSS style. Therefore consider this as a con= venience for the reader, not as a security tool.
The text of notes sections is also indexed.
For a document the references section contains pointers to resources tha= t prove the statements of the document.
Often these proofs are not easily distinguishable from further informati= on. In this case you may want to skip the reference section in favour for t= he resource list.
For further information please refer to References and Resources.
The resources section provides references to further information to the = topic of the document.
This may be information on the internet provided by the resource or info= rmation in the team's information systems. Anything the reader of the resou= rce might want to know, may be listed here.
For further information please refer to References and Resources.
<= span class=3D"confluence-embedded-file-wrapper image-right-wrapper confluen= ce-embedded-manual-size">The tex= t in the expand boxes is transcluded from the arc42 GitHub project w= here the arc42 Template is maintained by the original authors and supporters.
arc42 is owned by Dr. Peter Hruschka & Dr. Gernot Starke.