Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search Sign up Reseting focus

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

Product architecture document template

License

Notifications You must be signed in to change notification settings

bflorat/architecture-document-template

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Go to file

Folders and files

Last commit message Last commit date

Latest commit

History

View all files

Repository files navigation

Project architecture document template

This architecture template is applicable to most management IT projects, regardless of the general architecture chosen (monolithic, SOA, microservices, n-tier, …). It has already been used on several large projects in private or governmental organizations. It is maintained on a regular basis.

Others languages : French.

Principles of the template

We have divided the architecture into five views (application, security, sizing, infrastructure and development), each view being mostly self-supporting.

The idea is to offer a set of architecture views aligned with the roles that are most frequently found in organizations and their respective concerns. For example, an infrastructure architect or a DevOps engineer rarely needs to know the details of the software architecture (the details of the frameworks used or how to handle errors). Likewise, a PO or a business architect will be interested in the macroscopic view of application modules and their main interactions ("batch B calls service S") but rarely by the underlying infrastructure details (choice of service database, machine sizing, etc.).

A project documentation following this model will thus be constituted by :

an application view presenting the general context and the application architecture;
a development view presenting the software architecture and its environment;
a sizing view presenting aspects related to the performance and sizing of the infrastructure;
an infrastructure view presenting the servers, middleware, operations, etc.;
a security view.

Each section is divided according the following pattern :

Constraints (legal, budgetary, technological, normative, …) applicable to the project;
Non-functional requirements (NFR) expressed by the project leaders within the limits of the constraints;
Solution (description of the chosen architecture responding to the NFR).

The file also includes an example of a glossary which can be used as support for the Ubiquitous Language, a fundamental element of your architecture.

For more details, check out this paper published on Applied Computing and Informatics.