projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 1

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version Current

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 fifth chapter of the arc42 Template with information on the local building blocks, and their dependencies and relationships. 
Doctypedoctypehide
NameBuilding Block View 
IDswad-section 
Docsubtypeswad-section-building-block-view 
Suitearc42
Setarc42
 
hide
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 Key000500hide



Section
indextrue
show-titlefalse
titleDescription

Provides a static decomposition of the system into building blocks and the relationships between them.

This is the fifth 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.


Source: arc42 on GitHub

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

Section
titleLocal Building Blocks

List the root building blocks of your system.

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

The toplevel building blocks may be documented with View or Component documents. From there you may drill deeper iterating with Blackbox and Whitebox views. You may also consider to connect the building blocks with the view documents that show the context of the system (see System Scope and Context).

Use the Transclude Documents Macro to transclude from these view documents according to the information needs of your stakeholders.



Section
titleDependencies and Relationships

Explain the dependencies and relationships of the listed building blocks.

Tip Box
titleUsing projectdoc

This is a free text section. You may have a separate Section for each dependency or relationship and list them here. The list may contain references using the Display Table Macro or you may transclude the relevant part for your audience with the Transclude Documents Macro.

If the dependencies and relationships to explain are only a few with a limited amount of text, you may simply employ the Section Macro and create some subsections.



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