Best Practice:
1. Have two Technical Documents
a) A Higher level Architecture Document.
b) a more detailed how to guide. Programming
Higher level Architecture Document
Audience : the audience for this document is more general
a) System Administrators
b) Business Architects / BAs
c) Project Managers
d) Developers
e) UI Developers
f) Testers
Focus :
The Focus of this document should be
1. System Intigration.
a) Impact to other systems.
b) Interaction with other systems
c) To capture the nuances of communicating with each system
d) Ideally this document should have a section on each system that we are talking to.
e) From a Front end Launch point of view / From the Back end intigration point of view.
f) This document should talk about the recommended approaches of intigration
2. Information Flow . This document should also talk about
"The Owners of information". Which system should own the information and where is the information flowing from and to. Basically we do this. to avoid redundant data and Architecting system better from a Business Point of view.
3. Deployment :General Deployment guideline . It would seem a simple and trivial thing. But sometimes it turns out to be complecated. 1 EAR file , multiple WAR files.
To be continued.....