projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 2

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version 3

changes.mady.by.user Robert Reiner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionThe first chapter of the arc42 Template with information on constraints and conventions. 
Doctypedoctypehide
NameArchitecture Constraints 
IDswad-section 
Docsubtypeswad-section-constraints 
Setarc42 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 
Documentation Type
Name List
doctypedoctype-type
render-no-hits-as-blanktrue
propertyDocumentation Type
 
Categories
Name List
doctypedoctype-type
render-no-hits-as-blanktrue
namesQ4 - System
propertyDocumentation Type
 
Tags
Tag List
namesExtension, Software Development
 
Iteration
Iteration
valuefilled
hide
Sort Key000200hide
Section
indextrue
show-titlefalse
titleDescription

Lists any requirement that constrains software architects in their freedom of design decisions or the development process.

This is the second chapter of the arc42 Template.

...

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.

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, ...).

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

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.

Section
titleOrganizational Constraints

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

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

Tip Box
titleUsing projectdoc
Use the Project Constraint similar as shown for the technical constraints. Use the constraint type to select in your query.
Section
titleConventions

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

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

on GitHub

.org.

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

...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH