Difference between revisions of "SW Documentation"

Software architecture documentation takes place on the wiki, using Gliffy to include diagrams. The documentation is structured as a hierarchy of "building blocks", starting from the whole architecture landscape comprising "everything at a glance" and down to all the components, frameworks, services etc. with all their details that contribute to the realizing the actual system.

Each building block, unless its considered too small, has its own wiki space that is placed within the overall building block catalog – as well as the architecture navigator. Too small building blocks are simply part of the bigger building blocks they are part of.

This page describes to structure and fill in such a wiki space.

Creating the Wiki Space

The wiki space must be given the name of the building block followed by "Software Architecture" in brackets; for example "ETI (Software Architecture)". The addition of the text in brackets provide a welcome help when searching the wiki. There are no rules for space keys.

 

 

 

 

 

Text in black bold are pages within the wiki space, and the indentation defines how those pages are structures as a hierarchy (page tree). Pages at the lowest level of the hierarchy may include their own subpages, although such pages are not strictly defined and may vary depending on the building block. Text in green bold describes the purpose of the page (with any subpages) and provides a guideline for how to filll in content.