@rse/ase 0.9.0 → 0.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,51 @@
1
+
2
+ Artifact Meta Information
3
+ =========================
4
+
5
+ **ASE** knows about the following three levels of documentation:
6
+
7
+ - **Artifact Set**:
8
+
9
+ At the root, at level 1, there are the following known **Artifact Set**s:
10
+
11
+ - `Specification` (`SPEC`), aka "Software Requirements Specification
12
+ (SRS)", "Product Requirements Document (PRD)", or just
13
+ "Requirements".
14
+
15
+ - `Architecture` (`ARCH`), aka "Software Architecture Specification
16
+ (SAS)", "Architecture Description", or "Architecture Decision
17
+ Record (ADR)".
18
+
19
+ - `Software` (`SOFT`), aka "Software Implementation Results (IMP)".
20
+
21
+ - `Documentation` (`DOCS`), aka "Software Documentation Results (DOC)".
22
+
23
+ Each **Artifact Set** has a unique identifier <artifact-set-id/>,
24
+ which is one of `SPEC`, `ARCH`, `SOFT`, or `DOCS`.
25
+
26
+ - **Artifact**:
27
+
28
+ At level 2, each **Artifact Set** is composed of many **Artifact**s.
29
+ Each **Artifact** has a unique identifier <artifact-id/>, which is
30
+ an upper-case, two-letter identifier (e.g. `CJ` for `Customer
31
+ Journey`) derived from the **Artifact** name.
32
+
33
+ Each **Artifact** also has a sequence number <artifact-no/>, which
34
+ is the zero-padded, two-digit position of the **Artifact** (starting
35
+ at `01`) within the ordered list of **Artifact**s of its **Artifact
36
+ Set**. The <artifact-no/> is used only in the **Artifact**'s file
37
+ name (for stable ordering) and is *not* part of the **Artifact**'s
38
+ or its **Aspect**s' identifiers.
39
+
40
+ Each **Artifact** *MUST* have an initial blank line and a trailing
41
+ blank line. All its lines should be kept below 140 characters,
42
+ whenever possible by line-breaking with newlines after about 120
43
+ characters per line.
44
+
45
+ - **Aspect**:
46
+
47
+ At level 3, each **Artifact** is composed of many **Aspect**s.
48
+ Each **Aspect** has a unique identifier <aspect-id/>, which is a
49
+ unique "slug" of always 1-3 lower-cased words (concatenated with "-"
50
+ characters and in total not longer than 30 characters). An example
51
+ is `user-login`.