@brucewaynedecoy/make-docs 1.0.0-rc.1
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/LICENSE +201 -0
- package/README.md +93 -0
- package/dist/chunk-HP3HBG7F.js +626 -0
- package/dist/chunk-HP3HBG7F.js.map +1 -0
- package/dist/chunk-QRFH4J6H.js +1194 -0
- package/dist/chunk-QRFH4J6H.js.map +1 -0
- package/dist/chunk-WM3OXYTW.js +2630 -0
- package/dist/chunk-WM3OXYTW.js.map +1 -0
- package/dist/index.js +1720 -0
- package/dist/index.js.map +1 -0
- package/dist/skills-command-3ESCZ75U.js +547 -0
- package/dist/skills-command-3ESCZ75U.js.map +1 -0
- package/dist/uninstall-GQE4SJF2.js +150 -0
- package/dist/uninstall-GQE4SJF2.js.map +1 -0
- package/package.json +49 -0
- package/skill-registry.json +276 -0
- package/skill-registry.schema.json +64 -0
- package/template/.make-docs/scripts/check_path_hygiene.py +435 -0
- package/template/AGENTS.md +3 -0
- package/template/CLAUDE.md +3 -0
- package/template/docs/AGENTS.md +15 -0
- package/template/docs/CLAUDE.md +15 -0
- package/template/docs/assets/AGENTS.md +9 -0
- package/template/docs/assets/CLAUDE.md +9 -0
- package/template/docs/assets/archive/AGENTS.md +20 -0
- package/template/docs/assets/archive/CLAUDE.md +20 -0
- package/template/docs/assets/history/AGENTS.md +12 -0
- package/template/docs/assets/history/CLAUDE.md +12 -0
- package/template/docs/assets/prompts/AGENTS.md +8 -0
- package/template/docs/assets/prompts/CLAUDE.md +8 -0
- package/template/docs/assets/prompts/designs-to-plan-change.prompt.md +14 -0
- package/template/docs/assets/prompts/designs-to-plan.prompt.md +10 -0
- package/template/docs/assets/prompts/docs-path-hygiene-cleanup.prompt.md +27 -0
- package/template/docs/assets/prompts/plan-to-prd-change.prompt.md +8 -0
- package/template/docs/assets/prompts/plan-to-prd-green-field.prompt.md +6 -0
- package/template/docs/assets/prompts/prd-change-to-work.prompt.md +10 -0
- package/template/docs/assets/prompts/prd-to-work-full-prd.prompt.md +6 -0
- package/template/docs/assets/prompts/prd-to-work-prd-feature.prompt.md +6 -0
- package/template/docs/assets/prompts/request-to-design.prompt.md +16 -0
- package/template/docs/assets/prompts/session-to-history-record.prompt.md +19 -0
- package/template/docs/assets/prompts/update-readme-green-field.prompt.md +6 -0
- package/template/docs/assets/prompts/work-to-commit-message.prompt.md +27 -0
- package/template/docs/assets/prompts/work-to-guides.prompt.md +18 -0
- package/template/docs/assets/references/AGENTS.md +9 -0
- package/template/docs/assets/references/CLAUDE.md +9 -0
- package/template/docs/assets/references/commit-message-convention.md +198 -0
- package/template/docs/assets/references/design-contract.md +62 -0
- package/template/docs/assets/references/design-workflow.md +60 -0
- package/template/docs/assets/references/execution-workflow.md +157 -0
- package/template/docs/assets/references/guide-contract.md +159 -0
- package/template/docs/assets/references/harness-capability-matrix.md +52 -0
- package/template/docs/assets/references/history-record-contract.md +137 -0
- package/template/docs/assets/references/output-contract.md +221 -0
- package/template/docs/assets/references/path-and-link-hygiene.md +49 -0
- package/template/docs/assets/references/planning-workflow.md +160 -0
- package/template/docs/assets/references/prd-change-management.md +129 -0
- package/template/docs/assets/references/wave-model.md +76 -0
- package/template/docs/assets/templates/AGENTS.md +8 -0
- package/template/docs/assets/templates/CLAUDE.md +8 -0
- package/template/docs/assets/templates/design.md +30 -0
- package/template/docs/assets/templates/guide-developer.md +54 -0
- package/template/docs/assets/templates/guide-user.md +58 -0
- package/template/docs/assets/templates/history-record.md +62 -0
- package/template/docs/assets/templates/plan-overview.md +32 -0
- package/template/docs/assets/templates/plan-prd-change.md +99 -0
- package/template/docs/assets/templates/plan-prd-decompose.md +70 -0
- package/template/docs/assets/templates/plan-prd.md +124 -0
- package/template/docs/assets/templates/prd-architecture.md +51 -0
- package/template/docs/assets/templates/prd-change-addition.md +45 -0
- package/template/docs/assets/templates/prd-change-revision.md +45 -0
- package/template/docs/assets/templates/prd-glossary.md +15 -0
- package/template/docs/assets/templates/prd-index.md +45 -0
- package/template/docs/assets/templates/prd-overview.md +43 -0
- package/template/docs/assets/templates/prd-reference.md +17 -0
- package/template/docs/assets/templates/prd-risk-register.md +55 -0
- package/template/docs/assets/templates/prd-subsystem.md +49 -0
- package/template/docs/assets/templates/work-index.md +21 -0
- package/template/docs/assets/templates/work-phase.md +34 -0
- package/template/docs/designs/AGENTS.md +21 -0
- package/template/docs/designs/CLAUDE.md +21 -0
- package/template/docs/guides/AGENTS.md +15 -0
- package/template/docs/guides/CLAUDE.md +15 -0
- package/template/docs/plans/AGENTS.md +20 -0
- package/template/docs/plans/CLAUDE.md +20 -0
- package/template/docs/prd/AGENTS.md +9 -0
- package/template/docs/prd/CLAUDE.md +9 -0
- package/template/docs/work/AGENTS.md +18 -0
- package/template/docs/work/CLAUDE.md +18 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# {{TITLE}}
|
|
2
|
+
|
|
3
|
+
> In v2, work backlogs are directories. This template is the shape of the `00-index.md` entry-point file. Phase detail lives in sibling `0N-<phase>.md` files (see `work-phase.md`). See `docs/assets/references/wave-model.md` for W/R semantics.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
Describe what this work directory covers and how to navigate its phase files.
|
|
8
|
+
|
|
9
|
+
## Phase Map
|
|
10
|
+
|
|
11
|
+
| File | Purpose |
|
|
12
|
+
| --- | --- |
|
|
13
|
+
| [01-{{PHASE_SLUG}}.md](./01-{{PHASE_SLUG}}.md) | {{PHASE_ONE_PURPOSE}} |
|
|
14
|
+
| [02-{{PHASE_SLUG}}.md](./02-{{PHASE_SLUG}}.md) | {{PHASE_TWO_PURPOSE}} |
|
|
15
|
+
|
|
16
|
+
## Usage Notes
|
|
17
|
+
|
|
18
|
+
- Read phases in order unless otherwise noted.
|
|
19
|
+
- Keep phase files dependency-ordered.
|
|
20
|
+
- Every phase file must include `## Source PRD Docs`.
|
|
21
|
+
- Link every phase back to the relevant PRD docs.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Phase {{PHASE_NUMBER}}: {{PHASE_TITLE}}
|
|
2
|
+
|
|
3
|
+
> Shape for `0N-<phase>.md` files inside a work directory. See `docs/assets/references/wave-model.md` for W/R semantics.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
Explain why this phase exists and what foundation it depends on.
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
Explain the work covered by this phase and the value it unlocks.
|
|
12
|
+
|
|
13
|
+
## Source PRD Docs
|
|
14
|
+
|
|
15
|
+
- [{{DOC_TITLE}}](../../prd/{{DOC_PATH}})
|
|
16
|
+
- [{{DOC_TITLE}}](../../prd/{{DOC_PATH}})
|
|
17
|
+
|
|
18
|
+
## Stage {{STAGE_NUMBER}} - {{STAGE_NAME}}
|
|
19
|
+
|
|
20
|
+
### Tasks
|
|
21
|
+
|
|
22
|
+
- [ ] t1: {{TASK}}
|
|
23
|
+
- [ ] t2: {{TASK}}
|
|
24
|
+
|
|
25
|
+
### Acceptance criteria
|
|
26
|
+
|
|
27
|
+
- {{ACCEPTANCE}}
|
|
28
|
+
- {{ACCEPTANCE}}
|
|
29
|
+
|
|
30
|
+
### Dependencies
|
|
31
|
+
|
|
32
|
+
- {{DEPENDENCY}}
|
|
33
|
+
|
|
34
|
+
<!-- Insert additional STAGES as needed -->
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Designs Router
|
|
2
|
+
|
|
3
|
+
This directory is an output target for design docs.
|
|
4
|
+
|
|
5
|
+
## Naming Convention
|
|
6
|
+
|
|
7
|
+
Pattern: `YYYY-MM-DD-<slug>.md`
|
|
8
|
+
|
|
9
|
+
- Prefix with the creation date (today's date, never backdated).
|
|
10
|
+
- Slug: lowercase, hyphens only, no special characters.
|
|
11
|
+
- Example: `2026-04-16-authentication-flow.md`
|
|
12
|
+
|
|
13
|
+
## Agent Instructions
|
|
14
|
+
|
|
15
|
+
- Before writing, read `docs/assets/references/design-workflow.md`, `docs/assets/references/design-contract.md`, and `docs/assets/templates/design.md`.
|
|
16
|
+
- Use `docs/assets/references/design-contract.md` as the authority for lineage, required headings, and follow-on links.
|
|
17
|
+
- Always apply date-slug naming.
|
|
18
|
+
- Do not backdate designs — use today's date.
|
|
19
|
+
- Designs are living documents — update them when decisions change.
|
|
20
|
+
- Link to related plans, PRD docs, or work items where relevant.
|
|
21
|
+
- Archived designs live in `docs/assets/archive/designs/`; never archive unless the user explicitly asks. See `docs/assets/archive/AGENTS.md`.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Designs Router
|
|
2
|
+
|
|
3
|
+
This directory is an output target for design docs.
|
|
4
|
+
|
|
5
|
+
## Naming Convention
|
|
6
|
+
|
|
7
|
+
Pattern: `YYYY-MM-DD-<slug>.md`
|
|
8
|
+
|
|
9
|
+
- Prefix with the creation date (today's date, never backdated).
|
|
10
|
+
- Slug: lowercase, hyphens only, no special characters.
|
|
11
|
+
- Example: `2026-04-16-authentication-flow.md`
|
|
12
|
+
|
|
13
|
+
## Agent Instructions
|
|
14
|
+
|
|
15
|
+
- Before writing, read `docs/assets/references/design-workflow.md`, `docs/assets/references/design-contract.md`, and `docs/assets/templates/design.md`.
|
|
16
|
+
- Use `docs/assets/references/design-contract.md` as the authority for lineage, required headings, and follow-on links.
|
|
17
|
+
- Always apply date-slug naming.
|
|
18
|
+
- Do not backdate designs — use today's date.
|
|
19
|
+
- Designs are living documents — update them when decisions change.
|
|
20
|
+
- Link to related plans, PRD docs, or work items where relevant.
|
|
21
|
+
- Archived designs live in `docs/assets/archive/designs/`; never archive unless the user explicitly asks. See `docs/assets/archive/AGENTS.md`.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Guides for Devs and Users
|
|
2
|
+
|
|
3
|
+
Use `docs/guides` only as a router. Do not create generated files directly in this directory.
|
|
4
|
+
|
|
5
|
+
- Before writing any guide, read `docs/assets/references/guide-contract.md`, inspect existing guides for overlap, and decide whether the right outcome is `developer`, `user`, `both`, `update-existing`, `link-only`, or `none`.
|
|
6
|
+
- **User guides** are stored in `docs/guides/user/`. They explain the shipped product from a user's perspective, from novice orientation through advanced workflows. Use `docs/assets/templates/guide-user.md` when creating one.
|
|
7
|
+
- **Developer guides** are stored in `docs/guides/developer/`. They help contributors, maintainers, integrators, and operators navigate the codebase, docs, contracts, validation, extension points, and safe-change workflows. Use `docs/assets/templates/guide-developer.md` when creating one.
|
|
8
|
+
- Prefer updating an existing guide when it already owns the topic. Use cross-links and `related` frontmatter instead of duplicating full guides across audiences.
|
|
9
|
+
- After creating or updating guides, re-check overlapping guides and add reciprocal links, `related` frontmatter, or concise supplemental context when the new work improves their discoverability.
|
|
10
|
+
- If current confirmed behavior is useful but downstream work will expand it, write the current coverage now and add `## Future Coverage` for the blocked guide update.
|
|
11
|
+
- Do not create design docs, architecture decisions, or PRD risk-register items solely to remember future guide work.
|
|
12
|
+
- History records are not guides. Route them through `docs/assets/history/` instead.
|
|
13
|
+
- If the `docs/guides/user` or `docs/guides/developer` directories do not exist, create them ONLY when first writing a guide that belongs in the specific sub-folder.
|
|
14
|
+
|
|
15
|
+
Documentation must be easy to understand, easy to use, and easy to follow, with links to supporting sections or documents where necessary and where possible.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Guides for Devs and Users
|
|
2
|
+
|
|
3
|
+
Use `docs/guides` only as a router. Do not create generated files directly in this directory.
|
|
4
|
+
|
|
5
|
+
- Before writing any guide, read `docs/assets/references/guide-contract.md`, inspect existing guides for overlap, and decide whether the right outcome is `developer`, `user`, `both`, `update-existing`, `link-only`, or `none`.
|
|
6
|
+
- **User guides** are stored in `docs/guides/user/`. They explain the shipped product from a user's perspective, from novice orientation through advanced workflows. Use `docs/assets/templates/guide-user.md` when creating one.
|
|
7
|
+
- **Developer guides** are stored in `docs/guides/developer/`. They help contributors, maintainers, integrators, and operators navigate the codebase, docs, contracts, validation, extension points, and safe-change workflows. Use `docs/assets/templates/guide-developer.md` when creating one.
|
|
8
|
+
- Prefer updating an existing guide when it already owns the topic. Use cross-links and `related` frontmatter instead of duplicating full guides across audiences.
|
|
9
|
+
- After creating or updating guides, re-check overlapping guides and add reciprocal links, `related` frontmatter, or concise supplemental context when the new work improves their discoverability.
|
|
10
|
+
- If current confirmed behavior is useful but downstream work will expand it, write the current coverage now and add `## Future Coverage` for the blocked guide update.
|
|
11
|
+
- Do not create design docs, architecture decisions, or PRD risk-register items solely to remember future guide work.
|
|
12
|
+
- History records are not guides. Route them through `docs/assets/history/` instead.
|
|
13
|
+
- If the `docs/guides/user` or `docs/guides/developer` directories do not exist, create them ONLY when first writing a guide that belongs in the specific sub-folder.
|
|
14
|
+
|
|
15
|
+
Documentation must be easy to understand, easy to use, and easy to follow, with links to supporting sections or documents where necessary and where possible.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Plans Directory
|
|
2
|
+
|
|
3
|
+
This directory contains approach and rationale documents created before execution begins. Plans are always directories: an entry-point `00-overview.md` plus one or more `0N-<phase>.md` files.
|
|
4
|
+
|
|
5
|
+
## Naming Convention
|
|
6
|
+
|
|
7
|
+
Pattern: `YYYY-MM-DD-w{W}-r{R}-<slug>/`
|
|
8
|
+
|
|
9
|
+
- Inside the directory: `00-overview.md` plus one or more `0N-<phase>.md` files.
|
|
10
|
+
- Slug: lowercase, hyphens only, no special characters.
|
|
11
|
+
- Example: `docs/plans/2026-04-15-w1-r0-migration-strategy/` containing `00-overview.md`, `01-clean-room.md`, `02-integration.md`.
|
|
12
|
+
- See `docs/assets/references/wave-model.md` for W/R semantics.
|
|
13
|
+
|
|
14
|
+
## Agent Instructions
|
|
15
|
+
|
|
16
|
+
- Before writing, read `docs/assets/references/planning-workflow.md` and copy the matching template from `docs/assets/templates/` (`plan-overview.md` for `00-overview.md`; `plan-prd.md`, `plan-prd-decompose.md`, or `plan-prd-change.md` for the overview content shape).
|
|
17
|
+
- Always create the plan as a directory; even single-phase plans use the same shape with one `0N-<phase>.md` file.
|
|
18
|
+
- Apply the date-slug-W/R naming; do not backdate plans.
|
|
19
|
+
- Plans are written before execution, not retroactively.
|
|
20
|
+
- Archived plans live in `docs/assets/archive/plans/`. Never archive unless explicitly asked. See `docs/assets/archive/AGENTS.md`.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Plans Directory
|
|
2
|
+
|
|
3
|
+
This directory contains approach and rationale documents created before execution begins. Plans are always directories: an entry-point `00-overview.md` plus one or more `0N-<phase>.md` files.
|
|
4
|
+
|
|
5
|
+
## Naming Convention
|
|
6
|
+
|
|
7
|
+
Pattern: `YYYY-MM-DD-w{W}-r{R}-<slug>/`
|
|
8
|
+
|
|
9
|
+
- Inside the directory: `00-overview.md` plus one or more `0N-<phase>.md` files.
|
|
10
|
+
- Slug: lowercase, hyphens only, no special characters.
|
|
11
|
+
- Example: `docs/plans/2026-04-15-w1-r0-migration-strategy/` containing `00-overview.md`, `01-clean-room.md`, `02-integration.md`.
|
|
12
|
+
- See `docs/assets/references/wave-model.md` for W/R semantics.
|
|
13
|
+
|
|
14
|
+
## Agent Instructions
|
|
15
|
+
|
|
16
|
+
- Before writing, read `docs/assets/references/planning-workflow.md` and copy the matching template from `docs/assets/templates/` (`plan-overview.md` for `00-overview.md`; `plan-prd.md`, `plan-prd-decompose.md`, or `plan-prd-change.md` for the overview content shape).
|
|
17
|
+
- Always create the plan as a directory; even single-phase plans use the same shape with one `0N-<phase>.md` file.
|
|
18
|
+
- Apply the date-slug-W/R naming; do not backdate plans.
|
|
19
|
+
- Plans are written before execution, not retroactively.
|
|
20
|
+
- Archived plans live in `docs/assets/archive/plans/`. Never archive unless explicitly asked. See `docs/assets/archive/AGENTS.md`.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# PRD Router
|
|
2
|
+
|
|
3
|
+
This directory is an output target for the active PRD namespace and its change docs.
|
|
4
|
+
|
|
5
|
+
- Files use `NN-<slug>.md`; fixed-core filenames and lifecycle rules live in `docs/assets/references/output-contract.md`.
|
|
6
|
+
- `03-open-questions-and-risk-register.md` is the living register for gap state, open questions, resolved decisions, confirmed drift, and rebuild risks.
|
|
7
|
+
- Update the register directly for newly discovered or resolved gaps; do not create separate questions, decisions, risks, gaps, or architecture-decision files unless the user explicitly asks.
|
|
8
|
+
- Before writing, read `docs/assets/references/execution-workflow.md`, `docs/assets/references/output-contract.md`, `docs/assets/references/prd-change-management.md`, and the matching `prd-*` template in `docs/assets/templates/`.
|
|
9
|
+
- Treat the reference docs as the authority for namespace lifecycle, numbering, and validation.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# PRD Router
|
|
2
|
+
|
|
3
|
+
This directory is an output target for the active PRD namespace and its change docs.
|
|
4
|
+
|
|
5
|
+
- Files use `NN-<slug>.md`; fixed-core filenames and lifecycle rules live in `docs/assets/references/output-contract.md`.
|
|
6
|
+
- `03-open-questions-and-risk-register.md` is the living register for gap state, open questions, resolved decisions, confirmed drift, and rebuild risks.
|
|
7
|
+
- Update the register directly for newly discovered or resolved gaps; do not create separate questions, decisions, risks, gaps, or architecture-decision files unless the user explicitly asks.
|
|
8
|
+
- Before writing, read `docs/assets/references/execution-workflow.md`, `docs/assets/references/output-contract.md`, `docs/assets/references/prd-change-management.md`, and the matching `prd-*` template in `docs/assets/templates/`.
|
|
9
|
+
- Treat the reference docs as the authority for namespace lifecycle, numbering, and validation.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Work Directory
|
|
2
|
+
|
|
3
|
+
Output target for implementation backlogs. In v2, every backlog is a **directory** containing an index plus one or more phase files.
|
|
4
|
+
|
|
5
|
+
## Naming Convention
|
|
6
|
+
|
|
7
|
+
- Directory: `YYYY-MM-DD-w{W}-r{R}-<slug>/`
|
|
8
|
+
- Inside: `00-index.md` (entry point) + `0N-<phase>.md` (one per phase)
|
|
9
|
+
- Example: `docs/work/2026-04-15-w1-r0-payments-rollout/` containing `00-index.md`, `01-foundation.md`, `02-rollout.md`
|
|
10
|
+
- See `docs/assets/references/wave-model.md` for W/R semantics.
|
|
11
|
+
|
|
12
|
+
## Agent Instructions
|
|
13
|
+
|
|
14
|
+
- Before writing, read `docs/assets/references/execution-workflow.md` and copy the matching template from `docs/assets/templates/` (`work-index.md` for `00-index.md`; `work-phase.md` for phase files).
|
|
15
|
+
- In phase files, preserve markdown task syntax in `### Tasks` (`- [ ] t1: ...`) and keep `### Acceptance criteria` as plain bullets.
|
|
16
|
+
- Always create work as a directory; never a flat `.md` file.
|
|
17
|
+
- Apply the date-W/R-slug naming; do not backdate.
|
|
18
|
+
- Archived backlogs live in `docs/assets/archive/work/`. **Never archive unless explicitly asked.** See `docs/assets/archive/AGENTS.md`.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Work Directory
|
|
2
|
+
|
|
3
|
+
Output target for implementation backlogs. In v2, every backlog is a **directory** containing an index plus one or more phase files.
|
|
4
|
+
|
|
5
|
+
## Naming Convention
|
|
6
|
+
|
|
7
|
+
- Directory: `YYYY-MM-DD-w{W}-r{R}-<slug>/`
|
|
8
|
+
- Inside: `00-index.md` (entry point) + `0N-<phase>.md` (one per phase)
|
|
9
|
+
- Example: `docs/work/2026-04-15-w1-r0-payments-rollout/` containing `00-index.md`, `01-foundation.md`, `02-rollout.md`
|
|
10
|
+
- See `docs/assets/references/wave-model.md` for W/R semantics.
|
|
11
|
+
|
|
12
|
+
## Agent Instructions
|
|
13
|
+
|
|
14
|
+
- Before writing, read `docs/assets/references/execution-workflow.md` and copy the matching template from `docs/assets/templates/` (`work-index.md` for `00-index.md`; `work-phase.md` for phase files).
|
|
15
|
+
- In phase files, preserve markdown task syntax in `### Tasks` (`- [ ] t1: ...`) and keep `### Acceptance criteria` as plain bullets.
|
|
16
|
+
- Always create work as a directory; never a flat `.md` file.
|
|
17
|
+
- Apply the date-W/R-slug naming; do not backdate.
|
|
18
|
+
- Archived backlogs live in `docs/assets/archive/work/`. **Never archive unless explicitly asked.** See `docs/assets/archive/AGENTS.md`.
|