xdrs-core 0.24.1 → 0.26.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.
Files changed (34) hide show
  1. package/.xdrs/_core/adrs/index.md +19 -19
  2. package/.xdrs/_core/adrs/principles/001-xdrs-core.md +37 -37
  3. package/.xdrs/_core/adrs/principles/002-policy-standards.md +153 -0
  4. package/.xdrs/_core/adrs/principles/003-skill-standards.md +23 -22
  5. package/.xdrs/_core/adrs/principles/004-article-standards.md +23 -23
  6. package/.xdrs/_core/adrs/principles/{005-semantic-versioning-for-xdr-packages.md → 005-semantic-versioning-for-xdrs-packages.md} +11 -11
  7. package/.xdrs/_core/adrs/principles/006-research-standards.md +24 -24
  8. package/.xdrs/_core/adrs/principles/007-plan-standards.md +14 -14
  9. package/.xdrs/_core/adrs/principles/008-xdr-standards-structured.md +19 -19
  10. package/.xdrs/_core/adrs/principles/009-presentation-standards.md +11 -11
  11. package/.xdrs/_core/adrs/principles/articles/001-xdrs-overview.md +61 -50
  12. package/.xdrs/_core/adrs/principles/skills/{001-lint/001-lint.test.int.js → 001-review/001-review.test.int.js} +4 -4
  13. package/.xdrs/_core/adrs/principles/skills/{001-lint/001-lint.test.int.report → 001-review/001-review.test.int.report} +1 -1
  14. package/.xdrs/_core/adrs/principles/skills/001-review/SKILL.md +94 -0
  15. package/.xdrs/_core/adrs/principles/skills/002-write-policy/002-write-policy.test.int.js +24 -0
  16. package/.xdrs/_core/adrs/principles/skills/{002-write-xdr/002-write-xdr.test.int.report → 002-write-policy/002-write-policy.test.int.report} +2 -2
  17. package/.xdrs/_core/adrs/principles/skills/{002-write-xdr → 002-write-policy}/SKILL.md +40 -40
  18. package/.xdrs/_core/adrs/principles/skills/003-write-skill/SKILL.md +18 -18
  19. package/.xdrs/_core/adrs/principles/skills/004-write-article/SKILL.md +32 -32
  20. package/.xdrs/_core/adrs/principles/skills/005-write-research/SKILL.md +25 -25
  21. package/.xdrs/_core/adrs/principles/skills/006-write-plan/SKILL.md +17 -17
  22. package/.xdrs/_core/adrs/principles/skills/007-write-presentation/SKILL.md +14 -14
  23. package/.xdrs/_core/index.md +21 -26
  24. package/.xdrs/index.md +4 -4
  25. package/AGENTS.md +12 -12
  26. package/README.md +53 -40
  27. package/lib/lint.js +53 -48
  28. package/lib/lint.test.js +96 -96
  29. package/package.json +3 -3
  30. package/.xdrs/_core/adrs/principles/002-xdr-standards.md +0 -158
  31. package/.xdrs/_core/adrs/principles/skills/001-lint/SKILL.md +0 -94
  32. package/.xdrs/_core/adrs/principles/skills/002-write-xdr/002-write-xdr.test.int.js +0 -24
  33. package/.xdrs/_core/bdrs/index.md +0 -9
  34. package/.xdrs/_core/bdrs/principles/001-xdr-decisions-and-skills-usage.md +0 -52
@@ -2,60 +2,55 @@
2
2
 
3
3
  ## Overview
4
4
 
5
- The `_core` scope defines the XDR framework itself: how decision records, skills, research, articles, and plans are structured, written, versioned, and discovered. This scope is aimed at engineers, architects, and business analysts who build or consume XDR-based documentation.
5
+ The `_core` scope defines the XDRS framework itself: how policies, skills, research, articles, and plans are structured, written, versioned, and discovered. This scope is aimed at engineers, architects, and business analysts who build or consume xdrs-based documentation.
6
6
 
7
7
  ## Content
8
8
 
9
9
  ### What this scope covers
10
10
 
11
- The `_core` scope is the foundation that all other scopes inherit from. It establishes the rules and conventions that every XDR document, skill, article, research, and plan must follow regardless of which team, product, or domain produces them.
11
+ The `_core` scope is the foundation that all other scopes inherit from. It establishes the rules and conventions that every Policy document, skill, article, research, and plan must follow regardless of which team, product, or domain produces them.
12
12
 
13
- If you are evaluating whether to adopt XDRs, setting up a new XDR project, or extending the framework with your own scopes, start here.
13
+ If you are evaluating whether to adopt XDRS, setting up a new XDRS project, or extending the framework with your own scopes, start here.
14
14
 
15
15
  ### Framework structure and organization
16
16
 
17
- The core architectural decision [_core-adr-001](adrs/principles/001-xdrs-core.md) defines the fundamental building blocks: three decision types (ADR for architecture, BDR for business, EDR for engineering), scopes as grouping boundaries, subjects as topic categories within each type, and a folder layout that keeps everything discoverable. It also defines the index system (canonical type indexes, scope indexes, and the root index) that ties the collection together.
17
+ The core architectural decision [_core-adr-policy-001](adrs/principles/001-xdrs-core.md) defines the fundamental building blocks: three decision types (ADR for architecture, BDR for business, EDR for engineering), scopes as grouping boundaries, subjects as topic categories within each type, and a folder layout that keeps everything discoverable. It also defines the index system (canonical type indexes, scope indexes, and the root index) that ties the collection together.
18
18
 
19
19
  ### Document writing standards
20
20
 
21
21
  Each artifact type has its own writing standard:
22
22
 
23
- - **XDR documents** follow [_core-adr-002](adrs/principles/002-xdr-standards.md), which defines the mandatory template, frontmatter metadata, applicability rules, conflict handling, and word limits that keep decisions concise and authoritative.
24
- - **Structured XDRs** with individually referenceable rules follow the extension [_core-adr-008](adrs/principles/008-xdr-standards-structured.md), adding numbered rule blocks and a dot-notation citation syntax.
25
- - **Skills** follow [_core-adr-003](adrs/principles/003-skill-standards.md), using the agentskills format so they work for both humans and AI agents on an automation gradient from fully manual to fully automated.
26
- - **Articles** follow [_core-adr-004](adrs/principles/004-article-standards.md), providing synthetic views that combine and link multiple XDRs, research, and skills without replacing them as the source of truth.
27
- - **Research** follows [_core-adr-006](adrs/principles/006-research-standards.md), using an IMRAD-based structure for studies that back decisions with reproducible evidence.
28
- - **Plans** follow [_core-adr-007](adrs/principles/007-plan-standards.md), capturing ephemeral execution plans with problem context, proposed solutions, milestones, and deliverables that are deleted after implementation.
23
+ - **Policy documents** follow [_core-adr-policy-002](adrs/principles/002-policy-standards.md), which defines the mandatory template, frontmatter metadata, applicability rules, conflict handling, and word limits that keep decisions concise and authoritative.
24
+ - **Structured Policies** with individually referenceable rules follow the extension [_core-adr-policy-008](adrs/principles/008-xdr-standards-structured.md), adding numbered rule blocks and a dot-notation citation syntax.
25
+ - **Skills** follow [_core-adr-policy-003](adrs/principles/003-skill-standards.md), using the agentskills format so they work for both humans and AI agents on an automation gradient from fully manual to fully automated.
26
+ - **Articles** follow [_core-adr-policy-004](adrs/principles/004-article-standards.md), providing synthetic views that combine and link multiple Policies, research, and skills without replacing them as the source of truth.
27
+ - **Research** follows [_core-adr-policy-006](adrs/principles/006-research-standards.md), using an IMRAD-based structure for studies that back decisions with reproducible evidence.
28
+ - **Plans** follow [_core-adr-policy-007](adrs/principles/007-plan-standards.md), capturing ephemeral execution plans with problem context, proposed solutions, milestones, and deliverables that are deleted after implementation.
29
29
 
30
30
  ### Versioning and distribution
31
31
 
32
- [_core-adr-005](adrs/principles/005-semantic-versioning-for-xdr-packages.md) defines how XDR packages use semantic versioning to communicate upgrade impact when decisions are shared across repositories or teams.
33
-
34
- ### Usage policy
35
-
36
- The business decision [_core-bdr-001](bdrs/principles/001-xdr-decisions-and-skills-usage.md) establishes how agents and humans must use XDR decisions and skills, separating policy authority (which lives in XDRs) from execution guidance (which lives in skills).
32
+ [_core-adr-policy-005](adrs/principles/005-semantic-versioning-for-xdrs-packages.md) defines how XDRS packages use semantic versioning to communicate upgrade impact when decisions are shared across repositories or teams.
37
33
 
38
34
  ### Presentation standards
39
35
 
40
- Slide presentations that support XDR documents follow [_core-adr-009](adrs/principles/009-presentation-standards.md). Slides use the Marp Markdown format, live in `.assets/` next to the document they support, and must maintain bidirectional links with the parent document.
36
+ Slide presentations that support XDRS documents follow [_core-adr-policy-009](adrs/principles/009-presentation-standards.md). Slides use the Marp Markdown format, live in `.assets/` next to the document they support, and must maintain bidirectional links with the parent document.
41
37
 
42
38
  ### Available skills
43
39
 
44
40
  The `_core` scope ships with seven skills that automate the most common framework operations:
45
41
 
46
- - **001-lint** reviews code and files against applicable XDRs
47
- - **002-write-xdr** guides creation of a new decision record
48
- - **003-write-skill** guides creation of a new skill package
49
- - **004-write-article** guides creation of a new article
50
- - **005-write-research** guides creation of a new research document
51
- - **006-write-plan** guides creation of a new execution plan
52
- - **007-write-presentation** guides creation of Marp slide presentations
42
+ - **_core-adr-skill-001-review** reviews code and files against applicable Policies
43
+ - **_core-adr-skill-002-write-policy** guides creation of a new Policy document
44
+ - **_core-adr-skill-003-write-skill** guides creation of a new skill package
45
+ - **_core-adr-skill-004-write-article** guides creation of a new article
46
+ - **_core-adr-skill-005-write-research** guides creation of a new research document
47
+ - **_core-adr-skill-006-write-plan** guides creation of a new execution plan
48
+ - **_core-adr-skill-007-write-presentation** guides creation of Marp slide presentations
53
49
 
54
50
  ### Getting started
55
51
 
56
- For a narrative introduction to the framework, including how elements differ, how to decide whether an XDR applies, and how to extend the framework with your own scopes, see the overview article [_core-article-001](adrs/principles/articles/001-xdrs-overview.md).
52
+ For a narrative introduction to the framework, including how elements differ, how to decide whether a Policy applies, and how to extend the framework with your own scopes, see the overview article [_core-adr-article-001](adrs/principles/articles/001-xdrs-overview.md).
57
53
 
58
54
  ## Type Indexes
59
55
 
60
- - [ADRs Index](adrs/index.md) - Architectural decisions about the XDR framework structure and standards
61
- - [BDRs Index](bdrs/index.md) - Business and operational decisions about framework usage policy
56
+ - [ADRs Index](adrs/index.md) - Architectural decisions about the XDRS framework structure and standards
package/.xdrs/index.md CHANGED
@@ -1,14 +1,14 @@
1
- # XDR Standards Index
1
+ # XDRS Index
2
2
 
3
- This index points to all type- and scope-specific XDR indexes. XDRs (Decision Records) cover Architectural (ADR), Business (BDR), and Engineering (EDR) decisions. Each scope has its own canonical index that lists all XDRs for that scope, organized by subject.
3
+ This index points to all type- and scope-specific XDRS indexes. It covers Architectural (ADR), Business (BDR), and Engineering (EDR) contents. Each scope has its own canonical index that lists all Policies, Skills, Articles and Plans for that scope, organized by subject.
4
4
 
5
5
  ## Scope Indexes
6
6
 
7
- XDRs in scopes listed last override the ones listed first
7
+ XDRS scopes listed last override the ones listed first
8
8
 
9
9
  ### _core
10
10
 
11
- Decisions about how XDRs work
11
+ Defines how XDRS framework work
12
12
  [View scope _core](_core/index.md)
13
13
 
14
14
  ---
package/AGENTS.md CHANGED
@@ -1,32 +1,32 @@
1
1
  # AGENTS.md
2
2
 
3
- **Purpose:** This file is intentionally brief. All project decisions and working instructions are captured as XDRs.
3
+ **Purpose:** This file is intentionally brief. All project decisions and working instructions are captured as Policies or Skills in the XDRS structure.
4
4
 
5
- ## XDR Consultation Is Mandatory For Every Request
5
+ ## Policy Consultation in XDRS Is Mandatory For Every Request
6
6
 
7
7
  Before answering **any** request — including simple Q&A, informational questions, and design questions — you MUST:
8
8
 
9
- 1. Read the XDR root index (default: [.xdrs/index.md](.xdrs/index.md)) to identify relevant XDRs.
10
- 2. Read the relevant XDR files.
11
- 3. Base your actions on those XDRs.
9
+ 1. Read the XDRS root index (default: [.xdrs/index.md](.xdrs/index.md)) to identify relevant Policies.
10
+ 2. Read the relevant Policy files.
11
+ 3. Base your actions on those Policies.
12
12
 
13
- This rule has NO exceptions. Simple questions ("which command?", "what pattern?", "how does X work?") still require XDR lookup first. Do not answer from general knowledge alone when an XDR may exist on the topic.
13
+ This rule has NO exceptions. Simple questions ("which command?", "what pattern?", "how does X work?") still require Policy lookup first. Do not answer from general knowledge alone when a Policy may exist on the topic.
14
14
 
15
15
  ## Steps
16
16
 
17
- 1. Consult XDRs **for every request**
18
- - You MUST search and follow Decision Records (XDRs) for architecture, engineering and business in the XDR root index (default: [.xdrs/index.md](.xdrs/index.md)) during Informational, Q&A questions, design, plan, implementation, test and review steps etc. This is the source of truth for this agent.
17
+ 1. Consult Policies in XDRS **for every request**
18
+ - You MUST search and follow Policies for architecture, engineering and business in the Policy root index (default: [.xdrs/index.md](.xdrs/index.md)) during Informational, Q&A questions, design, plan, implementation, test and review steps etc. This is the source of truth for this agent.
19
19
 
20
20
  2. **Verify all work with build, tests and linting before completion**
21
21
  - Always run build, lint-fix and test at the end of the implementation when changing code
22
22
  - Fix any issues
23
23
 
24
- 3. **Verify if implementation complies with XDRs**
25
- - Analyse your work against the XDRs and ensure implementation decisions follow guidelines and patterns
24
+ 3. **Verify if implementation complies with Policies from XDRS**
25
+ - Analyse your work against the Policies and ensure implementation decisions follow guidelines and patterns
26
26
  - Fix any issues
27
27
 
28
- 4. **Document decisions as XDRs when appropriate**
29
- - Check if what is being performed shouldn't be documented as an XDR in _local scope (because the decision has potential to be reused in the future or the topic is complex and would benefit from a document for clarity). Create or update existing documents accordingly.
28
+ 4. **Document decisions as Policies when appropriate**
29
+ - Check if what is being performed shouldn't be documented as a Policy in _local scope (because the decision has potential to be reused in the future or the topic is complex and would benefit from a document for clarity). Create or update existing documents accordingly.
30
30
 
31
31
  5. **Do not perform git operations unless explicitelly asked**
32
32
  - The developer should be in control of possible destructive operations on the workspace
package/README.md CHANGED
@@ -1,24 +1,35 @@
1
- # xdr-standards
1
+ # xdrs-core
2
2
 
3
- XDRs (eXtended Decision Records) is a standard for organizing Architectural (ADR), Business (BDR), and Engineering (EDR) decision records so that AI agents and humans can reliably find and follow them. Each XDR package bundles five document types: Decision Records (the source of truth), Research (exploratory backing), Skills (step-by-step procedural guides), Articles (synthetic overviews), and Plans (ephemeral execution guidance).
3
+ XDRS is a framework to structure, compile and distribute Architectural (ADR), Business (BDR), and Engineering (EDR) decision records contents so that AI agents and humans can reliably find and use them with hierarchical scopes and controlled rollout in the format of distributable versioned packages. Decision Records are decomposed into Research (why), Policies (what), Skills (how), Plan (when) and Articles (views) with a well structured index structure and the definition of hierarchical scopes.
4
4
 
5
- > **Note:** This repository contains a minimum set of standards and very basic set of ADRs that describe the proposed decisions structure. It is intended to be used as a foundation that other projects can reference, extend, or install as a dependency in order to bootstrap and create their own XDRs.
5
+ After preparation those elements can be downloaded anywhere and used to compose xdrs corpus, which can be used as a context source for AI agents, web site publishing, RAG applications etc.
6
+
7
+ > **Note:** This repository contains a minimum set of standards and a very basic set of ADRs that describe the proposed structure. It is intended to be used as a foundation that other projects can reference, extend, or install as a dependency in order to bootstrap and create their own XDRS packages.
6
8
 
7
9
  ## Objective
8
10
 
9
- Decision Records capture Architectural (ADR), Business (BDR), and Engineering (EDR) decisions. As organizations grow, hundreds of decisions accumulate across teams, levels, and domains. Without a consistent structure, AI agents cannot efficiently locate the right decisions for a given context, and humans cannot maintain or evolve them sustainably.
11
+ Policies capture Architectural (ADR), Business (BDR), and Engineering (EDR) decisions. As organizations grow, hundreds of decisions accumulate across teams, levels, and domains. Without a consistent structure, AI agents cannot efficiently locate the right decisions for a given context, and humans cannot maintain or evolve them sustainably.
12
+
13
+ This project defines a standard for organizing XDRS that satisfies the following requirements.
10
14
 
11
- This project defines a standard for organizing XDRs that satisfies the following requirements.
15
+ ## XDRS elements
12
16
 
13
- ## XDR elements
17
+ A traditional Decision Record normally combines several concerns in the same document:
18
+ - A **reason** (why the decision was made, options considered, evidence gathered)
19
+ - A **policy** (rules, core decision, what must be followed)
20
+ - A **plan** (consequences, implementation approach, how to roll out the decision)
21
+ - A **how-to** (step-by-step procedure for executing under the decision)
22
+ - A **view** (overview of the topic connecting related decisions together)
14
23
 
15
- Every XDR package contains five types of documents:
24
+ The XDRS framework separates these concerns into different document types, each with a clear role:
16
25
 
17
- - **Decision Records (XDRs)** — Architectural (ADR), Business (BDR), or Engineering (EDR) records that capture a single decision, its rationale, and the rules that follow from it. They are the source of truth.
18
- - **Research** — Exploratory documents that capture the problem being investigated, constraints or requirements, findings, and option tradeoffs that back a decision during its lifecycle. One research document may inform multiple downstream decisions, but it is not a replacement for the Decision Record.
26
+ - **Policies** — Documents that captures a policy, core decision, rule, guardrails or any other boundary, captured from a Architectural (ADR), Business (BDR), or Engineering (EDR) documents. They are the source of truth. This is the core document type in the framework.
27
+ - **Research** — Exploratory documents that capture the problem being investigated, constraints or requirements, findings, and option tradeoffs that back a decision during its lifecycle. One research document may inform multiple downstream decisions, but it is not a replacement for the Policy.
19
28
  - **Skills** — Step-by-step procedural guides that can be followed by humans, AI agents, or both. Skills are task-based artifacts with a concrete outcome and should include enough detail to verify the task was completed correctly. A skill may start as a fully manual procedure and evolve toward partial or full AI automation over time.
20
- - **Articles** — Synthetic explanatory texts that combine information from multiple XDRs, Research documents, and Skills around a specific topic or audience. They never replace XDRs as source of truth.
21
- - **Plans** — Ephemeral execution documents that describe a problem, proposed solution, and the approach and activities needed to solve it. Plans have a clear start and end and must be deleted after full implementation. Lasting outputs are captured as Decisions, Skills, Articles, or other artifacts.
29
+ - **Articles** — Synthetic explanatory texts that combine information from multiple Policies, Research documents, and Skills around a specific topic or audience. They never replace Policies as source of truth.
30
+ - **Plans** — Ephemeral execution documents that describe a problem, proposed solution, and the approach and activities needed to solve it. Plans have a clear start and end and must be deleted after full implementation. Lasting outputs are captured as Policies, Skills, Articles, or other artifacts.
31
+
32
+ The compilation process of a raw Decision Record is to distribute it into those different documents and create links between them. You can also use the framework standalone, generating these elements individually directly during the writing process without starting from a raw Decision Record.
22
33
 
23
34
  ## Getting started
24
35
 
@@ -27,12 +38,14 @@ Every XDR package contains five types of documents:
27
38
  2. On the workspace root folder, run `npx xdrs-core`
28
39
 
29
40
  The basic xdrs tooling should be installed in your workspace along with:
30
- - AGENTS.md pointing to the XDRs structure
31
- - XDR related skills and prompts for Copilot
41
+ - AGENTS.md pointing to the Policies structure
42
+ - XDRS related skills and prompts for Copilot
32
43
 
33
44
  3. Run a prompt such as:
34
45
 
35
- > Create an ADR about our decision on using Python for AI related projects. For high volume projects (expected >1000 t/s), an exception can be made on using Golang.
46
+ > Create a policy about our decision on using Python for AI related projects. For high volume projects (expected >1000 t/s), an exception can be made on using Golang.
47
+
48
+ > Compile ADR 043-python-package-manager into the XDRS structure
36
49
 
37
50
  ## Examples
38
51
 
@@ -45,7 +58,7 @@ Every XDR package contains five types of documents:
45
58
 
46
59
  ### Multi-scope support
47
60
 
48
- Different teams at different organizational levels make decisions that apply to different audiences. XDRs are organized by scope (e.g. `_core`, `business-x`, `business-y-mobileapp`) so that each team owns its own decision space. Scopes can extend or override decisions from broader scopes, with explicit precedence rules: scopes listed later in an index override those listed earlier.
61
+ Different teams at different organizational levels make decisions that apply to different audiences. XDRS are organized by scope (e.g. `_core`, `business-x`, `business-y-mobileapp`) so that each team owns its own decision space. Scopes can extend or override policies from broader scopes, with explicit precedence rules: scopes listed later in an index override those listed earlier.
49
62
 
50
63
  ### Subject grouping
51
64
 
@@ -53,26 +66,26 @@ Within each scope and type, decisions are grouped by subject (e.g. `application`
53
66
 
54
67
  ### Extensibility
55
68
 
56
- Over time, decisions from various teams and domains accumulate in a shared workspace. The folder structure `.xdrs/[scope]/[type]/[subject]/` is designed to accommodate new scopes, types, and subjects without reorganizing existing content. A root index at `.xdrs/index.md` points to all canonical scope indexes, and each canonical index is updated incrementally as new XDRs are added.
69
+ Over time, decisions from various teams and domains accumulate in a shared workspace. The folder structure `.xdrs/[scope]/[type]/[subject]/` is designed to accommodate new scopes, types, and subjects without reorganizing existing content. A root index at `.xdrs/index.md` points to all canonical scope indexes, and each canonical index is updated incrementally as new XDRS scopes are added.
57
70
 
58
71
  ### Distributability
59
72
 
60
- XDR packages are versioned and distributed via the npm registry. This allows teams to adopt specific decision sets at a specific version, rather than accepting all decisions at once. It avoids "all or nothing" situations when linting or checking adherence to decisions in the context of tech debt management. Teams can pin, upgrade, or override only the scopes that are relevant to them.
73
+ XDRS packages are versioned and distributed via the npm registry. This allows teams to adopt specific decision sets at a specific version, rather than accepting all decisions at once. It avoids "all or nothing" situations when linting or checking adherence to decisions in the context of tech debt management. Teams can pin, upgrade, or override only the scopes that are relevant to them.
61
74
 
62
75
  ### AI-agent friendliness
63
76
 
64
77
  The folder layout, file naming, and document format are designed so that AI agents can efficiently work with hundreds of decisions:
65
78
 
66
- - Each XDR is a small, focused Markdown file (target under 1300 words), covering one decision.
67
- - The canonical index per scope and type lists all XDRs with short descriptions, enabling agents to identify relevant records without reading every file.
79
+ - Each Policy is a small, focused Markdown file (target under 1300 words), covering a set of rules or statements.
80
+ - The canonical index per scope and type lists all XDRS elements with short descriptions, enabling agents to identify relevant records without reading every file.
68
81
  - The root index at `.xdrs/index.md` provides a single entry point for discovery.
69
- - XDR metadata gives agents a first-pass filter: check `valid-from` for the convergence date, then check `apply-to`, and finally the decision text itself to confirm the decision should be used in the current context. All documents present in the collection are considered active.
70
- - Decisions cross-reference each other by XDR ID rather than duplicating content, keeping individual files concise.
82
+ - Policy metadata gives agents a first-pass filter: check `valid-from` for the convergence date, then check `apply-to`, and finally the decision text itself to confirm the decision should be used in the current context. All documents present in the collection are considered active.
83
+ - Decisions cross-reference each other by Policy ID rather than duplicating content, keeping individual files concise.
71
84
  - Subject folders reduce the search space when a query maps to a known domain.
72
85
 
73
86
  ### Multi-agent framework support
74
87
 
75
- XDRs and skills must be usable by any type of AI agent, not only coding agents (e.g. GitHub Copilot, Cursor, Cline). General-purpose agent frameworks such as LangGraph, CrewAI, AutoGen, and similar orchestration runtimes must be able to consume XDRs without relying on IDE-specific tooling or conventions.
88
+ Policies and skills must be usable by any type of AI agent, not only coding agents (e.g. GitHub Copilot, Cursor, Cline). General-purpose agent frameworks such as LangGraph, CrewAI, AutoGen, and similar orchestration runtimes must be able to consume Policies without relying on IDE-specific tooling or conventions.
76
89
 
77
90
  This is especially important for BDRs: because business rules govern decisions that span both technical and non-technical workflows, agents built with any framework must be able to discover, fetch, and apply BDRs programmatically using only standard file-system or HTTP access to Markdown files.
78
91
 
@@ -85,8 +98,8 @@ This is especially important for BDRs: because business rules govern decisions t
85
98
  [type]/ # adrs | bdrs | edrs
86
99
  index.md # canonical index for this scope+type
87
100
  [subject]/
88
- [number]-[short-title].md # individual decision record
89
- .assets/ # optional local resources for subject-level XDR files
101
+ [number]-[short-title].md # individual policy document
102
+ .assets/ # optional local resources for subject-level Policy files
90
103
  researches/ # optional decision-backing research documents
91
104
  [number]-[short-title].md
92
105
  .assets/
@@ -94,7 +107,7 @@ This is especially important for BDRs: because business rules govern decisions t
94
107
  [number]-[skill-name]/
95
108
  SKILL.md
96
109
  .assets/
97
- articles/ # optional synthetic views over XDRs, Research, and Skills
110
+ articles/ # optional synthetic views over Policies, Research, and Skills
98
111
  [number]-[short-title].md
99
112
  .assets/
100
113
  plans/ # optional ephemeral execution plans
@@ -108,32 +121,32 @@ Document types:
108
121
  - **BDR** - Business Decision Record: business process and strategy decisions
109
122
  - **EDR** - Engineering Decision Record: engineering workflow and tooling decisions
110
123
  - **Research** - Exploratory support material used while evaluating or updating a decision. Research captures constraints, findings, options, and proposal tradeoffs, but it is not the source of truth.
111
- - **Skills** - Step-by-step procedural guides that can be followed by humans, AI agents, or both. Must comply with Decision Records, but add the execution detail they lack. Skills are not mandatory by themselves unless referenced by an XDR or another policy artifact. A skill may start as a fully manual human procedure and evolve incrementally toward partial or full AI automation without being restructured. Co-located with the XDRs they implement inside `skills/` sub-directories.
112
- - **Articles** - Synthetic views that explain concepts or combine information from multiple Decision Records, Research documents, and Skills into a coherent text for a specific topic or audience. Articles are not the source of truth; Decision Records take precedence when there is a conflict. Useful as navigational indexes that link related artifacts around a specific aspect.
113
- - **Plans** - Ephemeral execution documents that describe a problem, proposed solution, and the approach and activities needed to solve it. Plans have a clear start and end and must be deleted after full implementation. Lasting outputs are captured as Decisions, Skills, Articles, or other artifacts. Co-located with XDRs inside `plans/` sub-directories.
124
+ - **Skills** - Step-by-step procedural guides that can be followed by humans, AI agents, or both. Must comply with Policies, but add the execution detail they lack. Skills are not mandatory by themselves unless referenced by a Policy or another policy artifact. A skill may start as a fully manual human procedure and evolve incrementally toward partial or full AI automation without being restructured. Co-located with the Policies they implement inside `skills/` sub-directories.
125
+ - **Articles** - Synthetic views that explain concepts or combine information from multiple Policies, Research documents, and Skills into a coherent text for a specific topic or audience. Articles are not the source of truth; Policies take precedence when there is a conflict. Useful as navigational indexes that link related artifacts around a specific aspect.
126
+ - **Plans** - Ephemeral execution documents that describe a problem, proposed solution, and the approach and activities needed to solve it. Plans have a clear start and end and must be deleted after full implementation. Lasting outputs are captured as Policies, Skills, Articles, or other artifacts. Co-located with Policies inside `plans/` sub-directories.
114
127
 
115
- See [.xdrs/index.md](.xdrs/index.md) for the full list of active decision records.
128
+ See [.xdrs/index.md](.xdrs/index.md) for the full list of active policies.
116
129
 
117
- For a deeper overview of XDRs — objective, structure, guidelines, extension, and usage — see the [XDRs Overview article](.xdrs/_core/adrs/principles/articles/001-xdrs-overview.md).
118
- For packaging guidance on publishing your own reusable scope with DRs, Research documents, skills, and articles, see the [Create your own xdrs-core extension package article](.xdrs/_local/adrs/principles/articles/001-create-your-own-xdrs-extension-package.md), then compare [examples/basic-usage](examples/basic-usage) and [examples/mydevkit](examples/mydevkit).
130
+ For a deeper overview of XDRS — objective, structure, guidelines, extension, and usage — see the [XDRS Overview article](.xdrs/_core/adrs/principles/articles/001-xdrs-overview.md).
131
+ For packaging guidance on publishing your own reusable scope with Policies, Research documents, skills, and articles, see the [Create your own xdrs-core extension package article](.xdrs/_local/adrs/principles/articles/001-create-your-own-xdrs-extension-package.md), then compare [examples/basic-usage](examples/basic-usage) and [examples/mydevkit](examples/mydevkit).
119
132
 
120
133
  ## Flow: Decision -> Distribution -> Usage
121
134
 
122
- XDRs, Research documents, and skills follow a three-stage lifecycle that keeps decision-making decentralized while allowing controlled adoption across projects.
135
+ Policies, Research documents, and skills follow a three-stage lifecycle that keeps decision-making decentralized while allowing controlled adoption across projects.
123
136
 
124
137
  ### Decision
125
138
 
126
- Each scope manages its own set of XDR artifacts independently. Scope owners discuss and evolve decisions through whatever process fits their team, such as RFCs, pull requests, or architecture review boards. Research documents, XDRs, and skills are authored, reviewed, and merged within the scope's folder in the repository.
139
+ Each scope manages its own set of XDRS artifacts independently. Scope owners discuss and evolve decisions through whatever process fits their team, such as RFCs, pull requests, or architecture review boards. Research documents, Policies, and skills are authored, reviewed, and merged within the scope's folder in the repository.
127
140
 
128
141
  ### Distribution
129
142
 
130
143
  Once a set of decisions is ready to share, scope owners pack the relevant `.xdrs/[scope]/` folder into a versioned npm package using a tool such as [filedist](https://github.com/flaviostutz/filedist) and publish it to an npm registry, either public or a company-internal one. Versioning gives consumers explicit control over which revision of a scope's decisions they adopt, avoiding situations where a single breaking policy change is forced on all consumers at once.
131
144
 
132
- The same applies to Research documents, skills, articles, and any sibling `.assets/` folders: because they live alongside XDRs inside the scope folder, they are included in the same package and published together.
145
+ The same applies to Research documents, skills, articles, and any sibling `.assets/` folders: because they live alongside Policies inside the scope folder, they are included in the same package and published together.
133
146
 
134
147
  ### Usage
135
148
 
136
- A project that wants to follow a scope's decisions adds the corresponding npm package as a regular dependency. Using a tool such as [filedist](https://github.com/flaviostutz/filedist), the package contents are unpacked into the project's `.xdrs/` folder at install or update time. Updating the dependency version pulls in the latest XDRs, Research documents, and skills for that scope, keeping the project aligned with the scope owners' current decisions.
149
+ A project that wants to follow a scope's decisions adds the corresponding npm package as a regular dependency. Using a tool such as [filedist](https://github.com/flaviostutz/filedist), the package contents are unpacked into the project's `.xdrs/` folder at install or update time. Updating the dependency version pulls in the latest Policies, Research documents, and skills for that scope, keeping the project aligned with the scope owners' current decisions.
137
150
 
138
151
  Multiple scope packages can be combined in the same workspace by listing them as separate dependencies. Scope precedence (defined in `.xdrs/index.md`) determines which decisions take effect when scopes overlap.
139
152
 
@@ -152,13 +165,13 @@ Multiple scope packages can be combined in the same workspace by listing them as
152
165
 
153
166
  The published package exposes the `xdrs-core` CLI.
154
167
 
155
- - Bootstrap or extract managed XDR files with the existing `filedist`-backed commands such as `npx -y xdrs-core extract` and `npx -y xdrs-core check`.
156
- - Lint an XDR tree with `npx -y xdrs-core lint .`. By default, scopes whose files are listed in the workspace root `.filedist` file are treated as external and skipped; use `--all` to include them.
168
+ - Bootstrap or extract managed XDRS files with the existing `filedist`-backed commands such as `npx -y xdrs-core extract` and `npx -y xdrs-core check`.
169
+ - Lint a Policy tree with `npx -y xdrs-core lint .`. By default, scopes whose files are listed in the workspace root `.filedist` file are treated as external and skipped; use `--all` to include them.
157
170
 
158
171
  The `lint` command reads `./.xdrs/**` from the given workspace path and checks common consistency rules, including:
159
172
 
160
173
  - allowed scope, type, and subject folder structure
161
- - XDR numbering uniqueness per `scope/type`
174
+ - Policy numbering uniqueness per `scope/type`
162
175
  - skill numbering uniqueness per `scope/type/subject/skills`
163
176
  - article numbering uniqueness per `scope/type/subject/articles`
164
177
  - research numbering uniqueness per `scope/type/subject/researches`
@@ -166,8 +179,8 @@ The `lint` command reads `./.xdrs/**` from the given workspace path and checks c
166
179
  - plan `Expected end date:` field presence and ISO date format
167
180
  - canonical index presence and link consistency
168
181
  - root index coverage for all discovered canonical indexes
169
- - XDR metadata section placement and `valid-from` / `apply-to` field format
170
- - local markdown links between XDR documents, skills, articles, researches, and plans (excluding fenced code blocks)
182
+ - Policy metadata section placement and `valid-from` / `apply-to` field format
183
+ - local markdown links between Policy documents, skills, articles, researches, and plans (excluding fenced code blocks)
171
184
  - local image and `.assets/` links resolving inside the sibling `.assets/` folder for each document
172
185
 
173
186
  Examples: