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.Dismiss alert
Copy file name to clipboardExpand all lines: devdoc/adr/2024-01-project-architecture-documentation.adoc
+8-5Lines changed: 8 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
== Status
4
4
5
5
* Published
6
-
* Updated: 2024-10-29
6
+
* Updated: 2024-11-21
7
7
8
8
== Type
9
9
@@ -27,9 +27,9 @@ This can result in the following problems:
27
27
Changes should be documented in an _Architecture Decision Record_ (or _ADR_ for short).
28
28
This is similar to Java's JEP or Python's PEP, and blatantly copied from Jaybird Design Proposal (https://github.com/FirebirdSQL/jaybird/blob/master/devdoc/jdp/jdp-2019-01-jaybird-design-proposal.md[jdp-2019-01^]).
29
29
30
-
Compare to Jaybird Design Proposals, we removed some parts which don't seem relevant for a documentation project.
30
+
Compared to Jaybird Design Proposals, we removed some parts which don't seem relevant for a documentation project.
31
31
32
-
This includes, but is not limited to:
32
+
Use of ADRs includes, but is not limited to:
33
33
34
34
* Architectural changes to the documentation build
35
35
* Documentation structure and naming conventions
@@ -70,6 +70,9 @@ The status of the document.
70
70
Possible values:
71
71
72
72
* Draft
73
+
* Incomplete -- applicable _Draft_ only
74
+
+
75
+
Indicates that ADR is not yet complete (e.g. some sections are missing or incomplete), or actively being revised.
73
76
* Published: (date) -- the date is optional for living documents
74
77
* Updated by: (adr-reference)
75
78
* Replaced by: (adr-reference)
@@ -78,8 +81,8 @@ likely the feature described will never be implemented
78
81
* Updated: (date) -- the last date a previously published document was updated
79
82
+
80
83
This should be used when updating living documents.
81
-
For other types, it should be used only for textual corrections (i.e. typo fixes), or for (minor) changes which do not affect anything for application versions released after the original publish date.
82
-
Other changes to documents which are not living documents should be performed with a new ADR, and not modify the original ADR except for updating things like `Updated by` and `Replaced by`.
84
+
For other types, it should be used only for textual corrections (i.e. typo fixes), or for (minor) changes which do not affect anything for application versions released after the original publish date, or for updating or adding things like `Updated by` and `Replaced by`.
85
+
Other changes to documents which are not living documents should be performed with a new ADR, and not modify the original ADR.
83
86
* Depends on: (comma-separated list of adr-references)
0 commit comments