mmo-ref/landsandboat
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
landsandboat/documentation/adls
History
Exact
hooksta4 edfd41f8fb
Chore: Cleanup Mixed British/American Spelling to American English (#6470)
2024-12-01 20:55:23 +00:00
..
need_to_zone.md Add ADL for mustZone localvar changes 2021-07-13 10:06:09 -04:00
README.md [docs] Add ADL template and sol_refactoring.md 2021-06-07 13:19:30 +03:00
sol_refactoring.md Chore: Cleanup Mixed British/American Spelling to American English (#6470) 2024-12-01 20:55:23 +00:00

README.md

What is an ADL?

ADL stands for Architectural Design/Decision Log. It is a record of the reasoning behind large architectural or technical decisions made in the codebase. It can be easy for the reasons behind choices to be forgotten. Keeping a log of important or tricky decisions helps to inform new developers, and stops old ground being retrodden.

Format

Title

Name of chosen solution.

What was/is the problem?

A description of the problem. This can be technical if needed.

What were/are the options?

A list of the options, with links to relevant documentation. The strengths and weaknesses of each option should be listed.

What was chosen?

A description of which of the above options was chosen. Specifically explaining why it won out over the other options.

Misc Notes

A freeform explanation of anything that might be useful for future readers.