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 third chapter of the arc42 Template with information on context and external interfaces. 
Doctypedoctypehide
NameSystem Scope and Context 
IDswad-section 
Docsubtypeswad-section-context 
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 Key000300hide
Section
indextrue
show-titlefalse
titleDescription

Describes the context view that defines the boundaries of the system under development to distinguish it from neighbouring systems.

This is the third 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
titleBusiness Context

Identify all neighbouring systems and specify all logical/business data that is exchanged with the system under development. Add data formats and communication protocols with neighbouring systems and the general environment if these are not specified in detail with the relevant components.

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

Tip Box
titleUsing projectdoc

A context is typically documented with a View document. You may transclude from this document any sections that suites the information needs of your stakeholders.

Section
titleTechnical Context

Specify the communication channels linking your system to neighbouring systems and the environment.

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

Tip Box
titleUsing projectdoc
A context is typically documented with a View document. You may transclude from this document any sections that suites the information needs of your stakeholders.
Section
titleExternal Interfaces

For many building blocks you can describe its interfaces directly in the black box template of the building block. For complex interfaces - and external interfaces are normally very complex – it is worth while to describe them in separate sections.

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

Tip Box
titleUsing projectdoc
Use the Interface doctype and either list or transclude them in detail.
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