arch-doc

More documents

Recommendations

Info

What to Write About?• The documentation is divided into sections (views) explaining different aspectsof the application. The following list is a suggestion, it is often necessary toadd or remove views.– Functionality, what the user can do with the application.– Design, how the application is structured in layers, which patterns are used,important flows and components.– Security, for example authentication, authorization, encryption and logging.– Data, both OR-mapping and database design.– Non-functional requirements, describe all that are considered, e.g.,transactions, usability, response time, availability.– Deployment, explains processes and hardware.– Implementation, describes the delivered files.– Problems, are there unsolved issues? Here you can also cover discardedsolutions.–Architectural Documentation 6
Functionality View• The functionality section shall explain why theapplication exists.• Explain what the user can do with the application.• Cover only the most important features.• Illustrate with user interface screenshots.Architectural Documentation 7
Page 1 and 2: Architectural DocumentationArchitec
Page 3 and 4: The Prototype is Also Part of theDo
Page 5: How To Explain?• A good approach
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?