diff --git a/docs/adr/0000-use-architectural-decision-records.md b/docs/adr/0000-use-architectural-decision-records.md new file mode 100644 index 00000000000..edfe41f4e43 --- /dev/null +++ b/docs/adr/0000-use-architectural-decision-records.md @@ -0,0 +1,16 @@ +# Use Architectural Decision Records + +We need to record the architectural decisions made on this project. + +## Considered Alternatives + +* No record +* [DecisionRecord](https://github.com/schubmat/DecisionCapture) +* [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions), maintainable by [adr-tools](https://github.com/npryce/adr-tools) +* [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) +* [Other templates](https://github.com/joelparkerhenderson/architecture_decision_record) + +## Conclusion + +* *Chosen Alternative: Decision Record* +* That template is lean and fits most the development style diff --git a/docs/adr/index.md b/docs/adr/index.md new file mode 100644 index 00000000000..59e592a086c --- /dev/null +++ b/docs/adr/index.md @@ -0,0 +1,8 @@ +# Architectural Decision Records + +This lists the architectural decisions for JabRef. + +- [0000-use-architectural-decision-records.md](0000-use-architectural-decision-records) - Use Architectural Decision Records +- [template.md](template/) - the template + +More information on architectural decision records is available at . diff --git a/docs/adr/template.md b/docs/adr/template.md new file mode 100644 index 00000000000..e473bf5e5c9 --- /dev/null +++ b/docs/adr/template.md @@ -0,0 +1,36 @@ +# + +**UserStory:** + + + +## Considered Alternatives + +* +* +* + +## Conclusion + +* *Chosen Alternative: * +* + +## Comparison (Optional) + +### + +* + +* + +* - + +### + +* + +* + +* - + +### + +* + +* + +* -