alexflanagan / reference-architecture Goto Github PK

This is a collaborative effort to document our digital standards, tooling and process, you are welcome to contribute and suggest changes, please follow the contribution guidelines

Why

For new and existing team members & partners, a single place where all the technical knowledge and platform specifications can be documented, tracked and debated.

What

Table of Content

• Development
• Process
• API Platform
• Testing
• Delivery
• Security
• Performance

How

A thin and simple format documentation for technical resources, tools, platforms and decisions. Members can quickly and easily get context on "Why, What & How" for every part of our platform

A Public Github repository, with Markdown articles as content, (using the repository itself, rather than the "Github Wikis" Feature, this ensures:

• version tracking, and usage of github git gui features (blame, history, branches, diff, etc ...)
• publish into a static website using Github Pages
• leverage branch locking and other Github features only available in content repos

The format should follow this template

Conformance

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.