xdrs-core 0.5.0 → 0.6.0
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.
|
@@ -12,6 +12,15 @@ Foundational standards, principles, and guidelines.
|
|
|
12
12
|
- [_core-adr-003](principles/003-skill-standards.md) - **Skill standards**
|
|
13
13
|
- [_core-adr-004](principles/004-article-standards.md) - **Article standards**
|
|
14
14
|
|
|
15
|
+
## Skills
|
|
16
|
+
|
|
17
|
+
Step-by-step procedural guides for humans and AI agents.
|
|
18
|
+
|
|
19
|
+
- [001-lint](principles/skills/001-lint/SKILL.md) - **Lint** — review code and files against XDRs
|
|
20
|
+
- [002-write-xdr](principles/skills/002-write-xdr/SKILL.md) - **Write XDR** — create a new Decision Record
|
|
21
|
+
- [003-write-skill](principles/skills/003-write-skill/SKILL.md) - **Write Skill** — create a new skill package
|
|
22
|
+
- [004-write-article](principles/skills/004-write-article/SKILL.md) - **Write Article** — create a new article document
|
|
23
|
+
|
|
15
24
|
## Articles
|
|
16
25
|
|
|
17
26
|
Synthetic views combining XDRs and Skills around a specific topic.
|
|
@@ -76,3 +76,4 @@ when referencing an information from those documents.]
|
|
|
76
76
|
|
|
77
77
|
- [_core-adr-001 - XDR standards](001-xdr-standards.md)
|
|
78
78
|
- [_core-adr-003 - Skill standards](003-skill-standards.md)
|
|
79
|
+
- [004-write-article skill](skills/004-write-article/SKILL.md) - Step-by-step instructions for creating a new article
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: 004-write-article
|
|
3
|
+
description: >
|
|
4
|
+
Creates a new article document following XDR article standards: selects scope, type, subject, and number;
|
|
5
|
+
then writes a focused synthetic text that combines and links multiple XDRs and Skills around a topic.
|
|
6
|
+
Activate this skill when the user asks to create, add, or write a new article, guide, or overview document
|
|
7
|
+
within an XDR project.
|
|
8
|
+
metadata:
|
|
9
|
+
author: flaviostutz
|
|
10
|
+
version: "1.0"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Overview
|
|
14
|
+
|
|
15
|
+
Guides the creation of a well-structured article by following `_core-adr-004`, researching the XDRs and
|
|
16
|
+
Skills to synthesize, and producing a concise document that serves as a navigable view without duplicating
|
|
17
|
+
decision content.
|
|
18
|
+
|
|
19
|
+
## Instructions
|
|
20
|
+
|
|
21
|
+
### Phase 1: Understand the Article Goal
|
|
22
|
+
|
|
23
|
+
1. Read `.xdrs/_core/adrs/principles/004-article-standards.md` in full to internalize the template,
|
|
24
|
+
placement rules, numbering rules, and the constraint that articles are views, not decisions.
|
|
25
|
+
2. Identify the topic and intended audience from user input or context. Do NOT proceed without a clear
|
|
26
|
+
topic.
|
|
27
|
+
|
|
28
|
+
### Phase 2: Select Scope, Type, and Subject
|
|
29
|
+
|
|
30
|
+
**Scope** — use `_local` unless the user explicitly names another scope.
|
|
31
|
+
|
|
32
|
+
**Type** — match the type of the XDRs the article primarily synthesizes (`adrs`, `bdrs`, or `edrs`).
|
|
33
|
+
If the topic spans multiple types, use `adrs`.
|
|
34
|
+
|
|
35
|
+
**Subject** — pick the subject that best matches the article's topic (see `004-article-standards`).
|
|
36
|
+
If the article spans more than one subject, place it in `principles`.
|
|
37
|
+
|
|
38
|
+
### Phase 3: Assign a Number and Name
|
|
39
|
+
|
|
40
|
+
1. List `.xdrs/[scope]/[type]/[subject]/articles/` (create the folder if it does not exist).
|
|
41
|
+
2. Find the highest existing article number in that namespace and increment by 1. Never reuse numbers.
|
|
42
|
+
3. Choose a short lowercase kebab-case title that describes the topic clearly.
|
|
43
|
+
- Good: `onboarding-guide`, `checkout-flow-overview`, `api-design-principles`
|
|
44
|
+
- Avoid: `summary`, `notes`, `misc`
|
|
45
|
+
|
|
46
|
+
### Phase 4: Research XDRs and Skills to Synthesize
|
|
47
|
+
|
|
48
|
+
1. Read all XDRs and Skills relevant to the article topic across all scopes listed in `.xdrs/index.md`.
|
|
49
|
+
2. Identify the key points a reader needs to understand the topic end-to-end.
|
|
50
|
+
3. Collect XDR IDs and file paths for cross-references. Never copy decision text verbatim; link to it.
|
|
51
|
+
|
|
52
|
+
### Phase 5: Write the Article
|
|
53
|
+
|
|
54
|
+
Use the mandatory template from `004-article-standards`:
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
# [scope]-article-[number]: [Short Title]
|
|
58
|
+
|
|
59
|
+
## Overview
|
|
60
|
+
|
|
61
|
+
[Brief description of what this article covers and its intended audience. Under 3 lines.]
|
|
62
|
+
|
|
63
|
+
## Content
|
|
64
|
+
|
|
65
|
+
[Synthetic text combining and explaining the topic. Use links to Decision Records and Skills
|
|
66
|
+
when referencing information from those documents. Keep under 150 lines total.]
|
|
67
|
+
|
|
68
|
+
## References
|
|
69
|
+
|
|
70
|
+
- [XDR id or Skill name](relative/path/to/file.md) - Brief description of relevance
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Rules to apply while drafting:
|
|
74
|
+
|
|
75
|
+
- Write for the stated audience; avoid jargon unexplained elsewhere.
|
|
76
|
+
- Every factual claim must link back to the authoritative XDR or Skill.
|
|
77
|
+
- Never reproduce decision text verbatim; summarize and link.
|
|
78
|
+
- Keep the article under 150 lines; move detailed content to XDRs or Skills.
|
|
79
|
+
- Use lowercase file names. Never use emojis.
|
|
80
|
+
- If a conflict exists between the article and a Decision Record, note it and defer to the XDR.
|
|
81
|
+
|
|
82
|
+
### Phase 6: Place and Register
|
|
83
|
+
|
|
84
|
+
1. Save the file at `.xdrs/[scope]/[type]/[subject]/articles/[number]-[short-title].md`.
|
|
85
|
+
2. Add a link to the article in the canonical index for that scope+type (`.xdrs/[scope]/[type]/index.md`).
|
|
86
|
+
3. Add back-references in the XDRs and Skills that the article synthesizes, under their `## References`
|
|
87
|
+
section.
|
|
88
|
+
|
|
89
|
+
## Examples
|
|
90
|
+
|
|
91
|
+
**Input:** "Write an article about how skills work in this project."
|
|
92
|
+
|
|
93
|
+
**Expected actions:**
|
|
94
|
+
1. Read `004-article-standards.md`.
|
|
95
|
+
2. Topic: how skills work. Audience: developers new to the project.
|
|
96
|
+
3. Scope: `_local`, type: `adrs`, subject: `principles`.
|
|
97
|
+
4. Scan `.xdrs/_local/adrs/principles/articles/` — no articles exist → number is `001`.
|
|
98
|
+
5. Research `_core-adr-003` and all existing skill SKILL.md files.
|
|
99
|
+
6. Write `.xdrs/_local/adrs/principles/articles/001-skills-overview.md` following the template, linking
|
|
100
|
+
to `_core-adr-003` and the individual skill files.
|
|
101
|
+
7. Update `.xdrs/_local/adrs/index.md` with a link to the new article.
|
|
102
|
+
8. Add a reference to the article in `_core-adr-003` under `## References`.
|
|
103
|
+
|
|
104
|
+
## Edge Cases
|
|
105
|
+
|
|
106
|
+
- **Article vs. XDR confusion** — if the user asks for a document that makes a decision, write an XDR
|
|
107
|
+
(use the `002-write-xdr` skill), not an article.
|
|
108
|
+
- **Cross-subject topic** — place the article in `principles`, not in any single subject folder.
|
|
109
|
+
- **No existing articles folder** — create it; it is optional in the folder layout.
|
|
110
|
+
- **Conflicting information found** — note the conflict in the article and always defer to the XDR.
|
|
111
|
+
- **Article would exceed 150 lines** — move detailed content to a new Skills or XDR and link back.
|
package/package.json
CHANGED