Skip to content

Commit 4bd976f

Browse files
committedNov 21, 2024
Fix typo, add status Incomplete
1 parent ea21448 commit 4bd976f

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed
 

‎devdoc/adr/2024-01-project-architecture-documentation.adoc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
== Status
44

55
* Published
6-
* Updated: 2024-10-29
6+
* Updated: 2024-11-21
77

88
== Type
99

@@ -27,9 +27,9 @@ This can result in the following problems:
2727
Changes should be documented in an _Architecture Decision Record_ (or _ADR_ for short).
2828
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^]).
2929

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.
3131

32-
This includes, but is not limited to:
32+
Use of ADRs includes, but is not limited to:
3333

3434
* Architectural changes to the documentation build
3535
* Documentation structure and naming conventions
@@ -70,6 +70,9 @@ The status of the document.
7070
Possible values:
7171

7272
* 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.
7376
* Published: (date) -- the date is optional for living documents
7477
* Updated by: (adr-reference)
7578
* Replaced by: (adr-reference)
@@ -78,8 +81,8 @@ likely the feature described will never be implemented
7881
* Updated: (date) -- the last date a previously published document was updated
7982
+
8083
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.
8386
* Depends on: (comma-separated list of adr-references)
8487
+
8588
Expresses explicit dependency between ADRs.

0 commit comments

Comments
 (0)