Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 977 Bytes

README.md

File metadata and controls

28 lines (18 loc) · 977 Bytes

Architecture Design Record

This document serves as a starting point for writing ADRs @ Webscope.io

What is ADR?

ADR is a document that describes important architectural decisions done in the project, answers important questions that might pop up about this decision and serves as a future reference for the authors of the project or for the new people that are onboarded.

Read more about it here: https://github.com/joelparkerhenderson/architecture_decision_record

FAQ

Is there a specific structure I should stick with?

All Webscope's ADRs are written in Markdown. Template can be found in this folder and is based on this template 🙏

Where should I store these ADRs?

The best practise is to create a docs/ folder in your project