Documentation Release
Overview
Documentation can be written in a number of formats. We have chosen to separate between WYSIWYG files (e.g. MS Word), compiled text (e.g. LaTeX) and wiki-based documentation. The table below might help you to choose.
| Feature | Confluence | MS Word (WYSIWYG) | Compiled text | Plain text |
|---|---|---|---|---|
| Version Control | (/) | (/)1 | (/)(+) | (/)(+) |
| Coupling to artifact/system | (/) | (/) | (/)(+) | (/)(+) |
| Editing, technical personell | (/)(+) | (/) | (/) | (/) |
| Editing, non-technical personell | (/)(+) | (/) | (x) | |
| Viewing, technical personell | (/)(+) | (/) | (/) | |
| Viewing, non-technical personell | (/)(+) | (/)(+) | (/) | |
| Support for diagrams and pictures | (/) | (/) | (/) | (x) |
| Always updated | (/)(+) | (x) | (x) | (x) |
| Open Source/Free | (x)2 | (x)3 | (/) | (/) |
| Agile | (/) | (x) | (x) | (/) |
Legend: (/)(+) - easy, works very well (/) - possible (x) - not available 1 binary only 2 Open Source, academic and private licenses are available. See Atlassian Licensing and Pricing. 3 Open Office can be used instead of MS Office.
Documentation Templates
Resources
Introduction to UML 2 Deployment Diagrams UML: Deployment Diagram Example