arch-doc

More documents

Recommendations

Info

The Purpose of ArchitecturalDocumentation• The documentation shall give the reader goodunderstanding of the application's architecture anddesign.• The reader shall be able to modify and extend theapplication without violating architecture or design.• The documentation shall explain architecturaldecisions and show what has been considered. Thereader shall not be led to reiterate discussions orconsiderations.Architectural Documentation 2
The Prototype is Also Part of theDocumentation• The documentation consists of two parts:1. A prototype consisting of a first version of theapplication under development. It shall containenough code to explain the architecture anddesign. Note that this shall be production-qualitycode which has the standard (tested, commented,structured, etc.) we want the final application tohave.2. A written documentation (often called architecturedocument) explaining the architecture and design.Architectural Documentation 3
Page 1: Architectural DocumentationArchitec
Page 5 and 6: How To Explain?• A good approach
Page 7 and 8: Functionality View• The functiona
Page 9 and 10: Design View (cont’d)• It is oft
Page 11 and 12: Data View• The data section shall
Page 13 and 14: Implementation View• The implemen
Page 15 and 16: Problems View• The problems secti
Page 17 and 18: Common Mistakes• No or irrelevant
Page 19: Common Mistakes (cont’d)• No in

arch-doc

Create successful ePaper yourself

Delete template?

Save as template?