xdrs-core 0.13.0 → 0.14.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.
- package/.xdrs/_core/adrs/index.md +2 -6
- package/.xdrs/_core/adrs/principles/001-xdrs-core.md +9 -1
- package/.xdrs/_core/adrs/principles/002-xdr-standards.md +12 -17
- package/.xdrs/_core/adrs/principles/003-skill-standards.md +1 -1
- package/.xdrs/_core/adrs/principles/004-article-standards.md +1 -1
- package/.xdrs/_core/adrs/principles/006-research-standards.md +2 -2
- package/.xdrs/_core/adrs/principles/007-plan-standards.md +132 -0
- package/.xdrs/_core/adrs/principles/articles/001-xdrs-overview.md +19 -7
- package/.xdrs/_core/adrs/principles/skills/001-lint/001-lint.test.int.js +40 -0
- package/.xdrs/_core/adrs/principles/skills/001-lint/001-lint.test.int.report +23 -0
- package/.xdrs/_core/adrs/principles/skills/001-lint/SKILL.md +3 -3
- package/.xdrs/_core/adrs/principles/skills/002-write-xdr/002-write-xdr.test.int.js +24 -0
- package/.xdrs/_core/adrs/principles/skills/002-write-xdr/002-write-xdr.test.int.report +14 -0
- package/.xdrs/_core/adrs/principles/skills/002-write-xdr/SKILL.md +15 -7
- package/.xdrs/_core/adrs/principles/skills/003-write-skill/003-write-skill.test.int.js +24 -0
- package/.xdrs/_core/adrs/principles/skills/003-write-skill/003-write-skill.test.int.report +14 -0
- package/.xdrs/_core/adrs/principles/skills/003-write-skill/SKILL.md +1 -1
- package/.xdrs/_core/adrs/principles/skills/004-write-article/004-write-article.test.int.js +24 -0
- package/.xdrs/_core/adrs/principles/skills/004-write-article/004-write-article.test.int.report +17 -0
- package/.xdrs/_core/adrs/principles/skills/004-write-article/SKILL.md +1 -1
- package/.xdrs/_core/adrs/principles/skills/005-write-research/005-write-research.test.int.js +3 -19
- package/.xdrs/_core/adrs/principles/skills/005-write-research/005-write-research.test.int.report +5 -12
- package/.xdrs/_core/adrs/principles/skills/005-write-research/SKILL.md +1 -1
- package/.xdrs/_core/adrs/principles/skills/006-write-plan/SKILL.md +151 -0
- package/README.md +10 -3
- package/lib/lint.js +86 -38
- package/lib/testPrompt.js +1 -0
- package/package.json +1 -1
- package/.xdrs/_core/adrs/principles/researches/001-research-and-decision-lifecycle.md +0 -99
|
@@ -1,99 +0,0 @@
|
|
|
1
|
-
# _core-research-001: Research and decision lifecycle
|
|
2
|
-
|
|
3
|
-
## Abstract
|
|
4
|
-
|
|
5
|
-
This study evaluates where research material should be positioned in the XDR framework so teams can preserve decision traceability and option analysis without weakening XDRs as the authoritative source. Three placement strategies were assessed against the framework's discoverability and conciseness constraints. Subject-level co-location in a dedicated `researches/` folder alongside `skills/` and `articles/` was found to best preserve context, keep XDRs concise, and stay consistent with the existing folder conventions. The study recommends treating Research as a first-class optional supporting artifact at the subject level.
|
|
6
|
-
|
|
7
|
-
## Introduction
|
|
8
|
-
|
|
9
|
-
As the XDR framework grows, teams need space beyond a concise XDR to record the reasoned evaluation of options — constraints, findings, tradeoffs, and rejected paths — before or after a decision changes. Without a dedicated place for this material, long-form analysis migrates into pull request comments, shared documents, and chat threads, making it hard to discover and harder to review when facts or technology change.
|
|
10
|
-
|
|
11
|
-
Three structural concerns drive this study:
|
|
12
|
-
|
|
13
|
-
- XDRs must stay under roughly 1300 words so both humans and AI agents can parse them quickly.
|
|
14
|
-
- Supporting analysis must be discoverable without knowing where to look outside the XDR folder tree.
|
|
15
|
-
- The framework already has `skills/` and `articles/` co-located per subject; a research artifact needs to fit that model or justify a deviation.
|
|
16
|
-
|
|
17
|
-
Known constraints from the XDR model:
|
|
18
|
-
|
|
19
|
-
- XDRs are the authoritative source of truth; no other artifact may override them.
|
|
20
|
-
- Subject-level folder structure is the canonical navigation layer.
|
|
21
|
-
- The framework must remain simple enough to onboard with a short article.
|
|
22
|
-
|
|
23
|
-
Question: How should a Research artifact fit into the XDR model so it supports the decision lifecycle without diluting the role of XDRs as the source of truth?
|
|
24
|
-
|
|
25
|
-
## Methods
|
|
26
|
-
|
|
27
|
-
This study used a structured option evaluation approach:
|
|
28
|
-
|
|
29
|
-
1. Catalogued the current XDR folder model and subject-level artifacts (`skills/`, `articles/`) from `_core-adr-001`.
|
|
30
|
-
2. Identified the key discoverability and maintenance constraints documented in `_core-adr-001`.
|
|
31
|
-
3. Defined three candidate placement strategies for research material based on common documentation pattern variants.
|
|
32
|
-
4. Assessed each option against four criteria: proximity to the relevant XDR, impact on XDR conciseness, discoverability for subjects with multiple related XDRs, and overall framework simplicity.
|
|
33
|
-
|
|
34
|
-
No external benchmarks were used. Assessment is based on the existing XDR structural rules and professional judgment about folder-based discoverability in developer tooling ecosystems.
|
|
35
|
-
|
|
36
|
-
## Results
|
|
37
|
-
|
|
38
|
-
Three placement strategies were evaluated:
|
|
39
|
-
|
|
40
|
-
| Option | Placement | Proximity to XDR | XDR Conciseness | Simplicity |
|
|
41
|
-
|--------|-----------|-----------------|-----------------|------------|
|
|
42
|
-
| 1 | Inside the XDR file | High (same file) | Low (bloat risk) | High |
|
|
43
|
-
| 2 | Global `researches/` tree | Low (detached from subjects) | High | Medium |
|
|
44
|
-
| 3 | Subject-level `researches/` | High (same subject) | High | Medium |
|
|
45
|
-
|
|
46
|
-
### Option 1: Keep research inside XDRs
|
|
47
|
-
|
|
48
|
-
Use larger XDRs and keep all exploratory analysis in the same file as the final decision.
|
|
49
|
-
|
|
50
|
-
**Pros**
|
|
51
|
-
- One file per decision thread.
|
|
52
|
-
- No new folder type to learn or maintain.
|
|
53
|
-
|
|
54
|
-
**Cons**
|
|
55
|
-
- Makes XDRs too long and hard to scan.
|
|
56
|
-
- Weakens the under-1300-word size constraint for decision records.
|
|
57
|
-
|
|
58
|
-
### Option 2: Create a top-level shared research area
|
|
59
|
-
|
|
60
|
-
Store all research under a global `researches/` tree detached from subjects.
|
|
61
|
-
|
|
62
|
-
**Pros**
|
|
63
|
-
- Centralized catalog of studies; easy to browse all research at once.
|
|
64
|
-
|
|
65
|
-
**Cons**
|
|
66
|
-
- Loses proximity to the decisions it informed.
|
|
67
|
-
- Makes subject-scoped discovery and maintenance harder.
|
|
68
|
-
- Inconsistent with how `skills/` and `articles/` are organized.
|
|
69
|
-
|
|
70
|
-
### Option 3: Add `researches/` beside `skills/` and `articles/`
|
|
71
|
-
|
|
72
|
-
Keep research documents under the same subject folder as the XDR they support.
|
|
73
|
-
|
|
74
|
-
**Pros**
|
|
75
|
-
- Preserves context: evidence lives beside the decision it informed.
|
|
76
|
-
- Keeps XDRs concise while retaining detailed tradeoff history.
|
|
77
|
-
- Consistent with the existing `skills/` and `articles/` co-location pattern.
|
|
78
|
-
|
|
79
|
-
**Cons**
|
|
80
|
-
- Adds one more artifact type to explain and maintain.
|
|
81
|
-
- Requires canonical indexes to cover one additional optional folder.
|
|
82
|
-
|
|
83
|
-
## Discussion
|
|
84
|
-
|
|
85
|
-
Option 3 dominates the evaluation on the key criteria. Subject-level co-location is what makes `skills/` and `articles/` discoverable in practice; research benefits from the same property. A global research tree (Option 2) loses the proximity that makes it useful when revisiting a decision, and inline analysis (Option 1) conflicts directly with the under-1300-word XDR guideline.
|
|
86
|
-
|
|
87
|
-
The main cost of Option 3 is framework complexity: teams must learn a new artifact type and canonical indexes must cover one more folder. This cost is real but modest. The XDR framework already has four artifact types (XDR, Skill, Article, Index); adding Research brings it to five, adding only one new section to the index template and one new optional folder per subject.
|
|
88
|
-
|
|
89
|
-
A risk worth noting: teams may resist creating a separate research file for simple decisions. This is acceptable. Research documents are optional and are most valuable for decisions with non-trivial option tradeoffs, evolving constraints, or evidence worth preserving for future reviews. For simple decisions, brief inline rationale in the XDR itself remains appropriate as long as the total XDR length stays under 1300 words.
|
|
90
|
-
|
|
91
|
-
## Conclusion
|
|
92
|
-
|
|
93
|
-
Subject-level co-location in `researches/[number]-[short-title].md` alongside the XDR is the model that best preserves discoverability, keeps XDRs concise, and stays consistent with existing folder conventions. Option 1 (inline) conflicts with the XDR size constraint; Option 2 (global tree) breaks subject-level proximity. The framework overhead of an optional `researches/` folder is low relative to the lifecycle traceability it provides. Research is optional and most useful for non-trivial decisions; for simple decisions, inline rationale remains acceptable within the 1300-word XDR budget.
|
|
94
|
-
|
|
95
|
-
## References
|
|
96
|
-
|
|
97
|
-
- [_core-adr-006](../006-research-standards.md) - Decision that adopts research as a first-class artifact
|
|
98
|
-
- [_core-adr-001](../001-xdrs-core.md) - Base XDR structure and folder conventions
|
|
99
|
-
- [_core-adr-004](../004-article-standards.md) - Distinction between research (evidence) and synthesis (articles)
|