projectdoc Toolbox

Space shortcuts

Page tree

projectdoc Toolbox


System Scope and Context

The third chapter of the arc42 Template with information on context and external interfaces.

ID
swad-section
Docsubtype
swad-section-context
Suite
arc42
Parent
arc42 Template
Categories
Q4 - System
Tags

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.

Properties

The document type swad-section provides the following properties:

 

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

Docsubtype

The subtype of the document type identifies the document instance within its swad-section doctype.

Sections

Description

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

Summary

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

Business 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.org.

Using 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.

Technical 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.org.

Using 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.

External 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.org.

Using projectdoc

 
Use the Interface doctype and either list or transclude them in detail.

Notes

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 information. 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 suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.

 

The text of notes sections is also indexed.

References

For a document the references section contains pointers to resources that prove the statements of the document.

Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.

 

For further information please refer to References and Resources.

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 information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.

 

For further information please refer to References and Resources.

References

The text in the expand boxes is transcluded from the arc42 GitHub project where the arc42 Template is maintained by the original authors and supporters.

arc42 is owned by Dr. Peter Hruschka & Dr. Gernot Starke.

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