arch-doc
A Sample Architecture Document1. Title Page with author, application name, organization name.2. Revision History3. Table of Content4. Introduction, briefly explains the application and why and where it is developed.5. Functionality View6. Design View7. Security View8. Data View9. Non-Functional View10. Deployment View11. Implementation View12. Problems13. ReferencesArchitectural Documentation 16
Common Mistakes• No or irrelevant images.– Images make it a lot easier to understand the body text, but theymust be relevant and referenced in the body text.• Very little text.– Even though images enhance understanding they can neversubstitute body text.• Too big UML diagrams.– UML diagrams that are generated from the code by a tool willinclude all the application’s details. Such diagrams obscure theimportant parts unless they are edited.Architectural Documentation 17
- Page 1 and 2: Architectural DocumentationArchitec
- Page 3 and 4: The Prototype is Also Part of theDo
- 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: Problems View• The problems secti
- Page 19: Common Mistakes (cont’d)• No in
Common Mistakes
• No or irrelevant images.
– Images make it a lot easier to understand the body text, but they
must be relevant and referenced in the body text.
• Very little text.
– Even though images enhance understanding they can never
substitute body text.
• Too big UML diagrams.
– UML diagrams that are generated from the code by a tool will
include all the application’s details. Such diagrams obscure the
important parts unless they are edited.
Architectural Documentation 17
Change language