@pieai/pro-gov 0.3.3
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 +21 -0
- package/README.md +47 -0
- package/assets/docs/reference/adoption/adoption-playbook.md +215 -0
- package/assets/docs/reference/adoption/downstream-project-registry.md +78 -0
- package/assets/docs/reference/adoption/migration-v0.9.md +74 -0
- package/assets/docs/reference/adoption/project-relationship.md +128 -0
- package/assets/docs/reference/adoption/public-release-checklist.md +123 -0
- package/assets/docs/reference/adoption/site-publication-brief.md +86 -0
- package/assets/integrations/directed-development.md +36 -0
- package/assets/integrations/superpowers.md +52 -0
- package/assets/profiles/doc-only/manifest.yml +21 -0
- package/assets/profiles/doc-only/profile.md +37 -0
- package/assets/profiles/engineering-runtime/manifest.yml +22 -0
- package/assets/profiles/engineering-runtime/profile.md +39 -0
- package/assets/starter/.github/workflows/docs-check.yml +59 -0
- package/assets/starter/AGENTS.template.md +48 -0
- package/assets/starter/CLAUDE.template.md +6 -0
- package/assets/starter/docs/archive/.gitkeep +1 -0
- package/assets/starter/docs/canon/.gitkeep +1 -0
- package/assets/starter/docs/decisions/.gitkeep +1 -0
- package/assets/starter/docs/governance/agents-routing/doc-only-v0.9.md +83 -0
- package/assets/starter/docs/governance/agents-routing/engineering-runtime-v0.9.md +78 -0
- package/assets/starter/docs/governance/boundary.md +76 -0
- package/assets/starter/docs/governance/doc-agent-rules.md +71 -0
- package/assets/starter/docs/governance/doc-types.md +50 -0
- package/assets/starter/docs/governance/ssot-v0.9.md +166 -0
- package/assets/starter/docs/governance/templates/adr.md +24 -0
- package/assets/starter/docs/governance/templates/archive.md +23 -0
- package/assets/starter/docs/governance/templates/canon-entry.md +24 -0
- package/assets/starter/docs/governance/templates/plan.md +33 -0
- package/assets/starter/docs/governance/templates/policy.md +24 -0
- package/assets/starter/docs/governance/templates/reference.md +24 -0
- package/assets/starter/docs/governance/templates/spec.md +24 -0
- package/assets/starter/docs/plans/active/.gitkeep +1 -0
- package/assets/starter/docs/plans/completed/.gitkeep +1 -0
- package/assets/starter/docs/policy/best-practice-for-this-project.md +35 -0
- package/assets/starter/docs/reference/documentation-map.md +51 -0
- package/assets/starter/docs/reference/execution/current-work.md +36 -0
- package/assets/starter/docs/specs/active/.gitkeep +1 -0
- package/assets/starter/docs/specs/completed/.gitkeep +1 -0
- package/assets/starter/lefthook.template.yml +18 -0
- package/cli-guide.md +36 -0
- package/dist/cli.js +244 -0
- package/package.json +56 -0
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: POLICY-DOC-AGENT-RULES
|
|
3
|
+
title: Documentation Agent Rules
|
|
4
|
+
type: policy
|
|
5
|
+
status: stable
|
|
6
|
+
canonical: true
|
|
7
|
+
owner: project
|
|
8
|
+
created: 2026-05-08
|
|
9
|
+
last_reviewed: 2026-06-12
|
|
10
|
+
domain: doc-governance
|
|
11
|
+
tags:
|
|
12
|
+
- doc-gov
|
|
13
|
+
- agent-rules
|
|
14
|
+
pinned: true
|
|
15
|
+
related:
|
|
16
|
+
- POLICY-DOC-TYPES
|
|
17
|
+
supersedes: []
|
|
18
|
+
superseded_by: null
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
# Documentation Agent Rules
|
|
22
|
+
|
|
23
|
+
This file belongs in `docs/governance/` because it governs how the documentation
|
|
24
|
+
system itself behaves.
|
|
25
|
+
|
|
26
|
+
Doc-gov governs `docs/**` by default. Do not move product prompts, generated
|
|
27
|
+
media notes, source assets, runtime docs, or project-package Markdown into
|
|
28
|
+
`docs/**` unless the project explicitly opts those files into governance.
|
|
29
|
+
|
|
30
|
+
## Before Creating Docs
|
|
31
|
+
|
|
32
|
+
Run:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
pnpm doc-gov find <topic>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
If a canonical document exists, update it instead of creating a parallel document.
|
|
39
|
+
|
|
40
|
+
## Closed Document Types
|
|
41
|
+
|
|
42
|
+
Use only:
|
|
43
|
+
|
|
44
|
+
- `policy`
|
|
45
|
+
- `decision`
|
|
46
|
+
- `spec`
|
|
47
|
+
- `plan`
|
|
48
|
+
- `canon`
|
|
49
|
+
- `reference`
|
|
50
|
+
- `archive`
|
|
51
|
+
|
|
52
|
+
## Status Machine
|
|
53
|
+
|
|
54
|
+
Normal documents:
|
|
55
|
+
|
|
56
|
+
```text
|
|
57
|
+
draft -> active -> completed -> stable -> superseded -> archived
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Decision documents:
|
|
61
|
+
|
|
62
|
+
```text
|
|
63
|
+
proposed -> accepted -> rejected | superseded
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
`completed` is for finished execution records or specs that should no longer appear in active folders.
|
|
67
|
+
|
|
68
|
+
## Upstream Rule
|
|
69
|
+
|
|
70
|
+
Do not locally invent doc-gov core changes. Propose core changes upstream in
|
|
71
|
+
the Project Governance System upstream repository.
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: POLICY-DOC-TYPES
|
|
3
|
+
title: Document Types
|
|
4
|
+
type: policy
|
|
5
|
+
status: stable
|
|
6
|
+
canonical: true
|
|
7
|
+
owner: project
|
|
8
|
+
created: 2026-05-08
|
|
9
|
+
last_reviewed: 2026-05-08
|
|
10
|
+
domain: doc-governance
|
|
11
|
+
tags:
|
|
12
|
+
- doc-gov
|
|
13
|
+
- document-types
|
|
14
|
+
pinned: true
|
|
15
|
+
related:
|
|
16
|
+
- POLICY-DOC-AGENT-RULES
|
|
17
|
+
supersedes: []
|
|
18
|
+
superseded_by: null
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
# Document Types
|
|
22
|
+
|
|
23
|
+
This file belongs in `docs/governance/` because it defines the document system's
|
|
24
|
+
own cabinets and lifecycle.
|
|
25
|
+
|
|
26
|
+
Allowed types:
|
|
27
|
+
|
|
28
|
+
| Type | Default path |
|
|
29
|
+
| --- | --- |
|
|
30
|
+
| `policy` | `docs/policy/` for project policy; `docs/governance/` for doc-system policy |
|
|
31
|
+
| `decision` | `docs/decisions/` |
|
|
32
|
+
| `spec` | `docs/specs/active/` or `docs/specs/completed/` |
|
|
33
|
+
| `plan` | `docs/plans/active/` or `docs/plans/completed/` |
|
|
34
|
+
| `canon` | `docs/canon/` |
|
|
35
|
+
| `reference` | `docs/reference/` |
|
|
36
|
+
| `archive` | `docs/archive/` |
|
|
37
|
+
|
|
38
|
+
Markdown outside `docs/**` is not a governed doc by default.
|
|
39
|
+
|
|
40
|
+
Normal documents use:
|
|
41
|
+
|
|
42
|
+
```text
|
|
43
|
+
draft -> active -> completed -> stable -> superseded -> archived
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Decision documents use:
|
|
47
|
+
|
|
48
|
+
```text
|
|
49
|
+
proposed -> accepted -> rejected | superseded
|
|
50
|
+
```
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: GOV-SSOT-V0-9
|
|
3
|
+
title: SSOT Documentation Governance Rules v0.9
|
|
4
|
+
type: policy
|
|
5
|
+
status: stable
|
|
6
|
+
canonical: true
|
|
7
|
+
owner: human
|
|
8
|
+
created: 2026-05-09
|
|
9
|
+
last_reviewed: 2026-05-09
|
|
10
|
+
domain: doc-governance
|
|
11
|
+
tags:
|
|
12
|
+
- ssot
|
|
13
|
+
- doc-gov
|
|
14
|
+
- boundary
|
|
15
|
+
pinned: true
|
|
16
|
+
related:
|
|
17
|
+
- REF-DOC-GOVERNANCE-BOUNDARY
|
|
18
|
+
supersedes: []
|
|
19
|
+
superseded_by: null
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
# SSOT Documentation Governance Rules v0.9
|
|
23
|
+
|
|
24
|
+
This rule defines how projects using Project Governance System handle
|
|
25
|
+
**SSOT (Single Source of Truth)** for governed documentation.
|
|
26
|
+
|
|
27
|
+
Use it whenever an AI agent creates, modifies, moves, deletes, archives, or
|
|
28
|
+
cross-references project documents.
|
|
29
|
+
|
|
30
|
+
Beginner version: every important fact should have one home. Other files can
|
|
31
|
+
point to that home, but they should not become competing copies.
|
|
32
|
+
|
|
33
|
+
## Governance Scope
|
|
34
|
+
|
|
35
|
+
Project Governance System governs:
|
|
36
|
+
|
|
37
|
+
- `AGENTS.md` and equivalent AI entry files.
|
|
38
|
+
- Governed Markdown under `docs/**`.
|
|
39
|
+
- Documentation governance rules, agent routing rules, templates, manifests,
|
|
40
|
+
plans, specs, decisions, references, canon, and archives that live under
|
|
41
|
+
`docs/**`.
|
|
42
|
+
|
|
43
|
+
Project Governance System does **not** automatically govern every Markdown file
|
|
44
|
+
or every asset in the repository.
|
|
45
|
+
|
|
46
|
+
Markdown outside `docs/**` can be a product artifact, source asset, prompt,
|
|
47
|
+
project package file, runtime note, generated media description, or local
|
|
48
|
+
workbench record. Do not move those files into `docs/**` just because they are
|
|
49
|
+
Markdown.
|
|
50
|
+
|
|
51
|
+
Extra governed roots are allowed only when a project explicitly opts in.
|
|
52
|
+
|
|
53
|
+
## Core Behavior
|
|
54
|
+
|
|
55
|
+
- **Discover before editing**: first identify the project's actual documentation
|
|
56
|
+
system and current entrypoints.
|
|
57
|
+
- **One truth surface**: each durable fact should have one canonical source;
|
|
58
|
+
other files should summarize and link.
|
|
59
|
+
- **Runtime beats Markdown**: when runtime code/config is the real product truth,
|
|
60
|
+
docs must point to it instead of duplicating it.
|
|
61
|
+
- **Product artifacts stay in their product package**: prompts, generated media,
|
|
62
|
+
asset manifests, project-package canon, and source materials should stay in
|
|
63
|
+
the project's own production/workbench structure unless the project explicitly
|
|
64
|
+
makes them governed docs.
|
|
65
|
+
- **No parallel systems**: do not keep old and new documentation structures alive
|
|
66
|
+
unless the project explicitly says it is in a migration window.
|
|
67
|
+
- **No AI dump folders inside governed docs**: do not create ad-hoc `Temp/`,
|
|
68
|
+
`Drafts/`, `Opus/`, `Codex/`, or AI-name folders under `docs/**`.
|
|
69
|
+
|
|
70
|
+
## Discovery Order
|
|
71
|
+
|
|
72
|
+
Before changing docs, look for project-local guidance in this order:
|
|
73
|
+
|
|
74
|
+
1. `AGENTS.md`, `CLAUDE.md`, `GEMINI.md`, or equivalent AI router.
|
|
75
|
+
2. `docs/governance/boundary.md`.
|
|
76
|
+
3. `docs/governance/ssot-v0.9.md`.
|
|
77
|
+
4. `docs/governance/agents-routing/` and the project's selected agents-routing file.
|
|
78
|
+
5. `docs/reference/documentation-map.md`, root `README.md` for human-facing
|
|
79
|
+
orientation, or another project-defined documentation index.
|
|
80
|
+
6. `docs/policy/`, `docs/governance/`, or equivalent project rules.
|
|
81
|
+
7. Any project-specific doc tooling such as `doc-gov`, `mintlify`,
|
|
82
|
+
`docusaurus`, `vitepress`, or custom scripts.
|
|
83
|
+
8. Runtime truth locations named by the project, such as config files, schemas,
|
|
84
|
+
manifests, source packages, product packages, or asset manifests.
|
|
85
|
+
|
|
86
|
+
If the project uses `doc-gov`, follow it:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
pnpm doc-gov find <topic>
|
|
90
|
+
pnpm doc-gov check
|
|
91
|
+
pnpm doc-gov scan --check
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Do not invent a second structure when doc-gov already defines one.
|
|
95
|
+
|
|
96
|
+
## Choosing The Truth Layer
|
|
97
|
+
|
|
98
|
+
Use the project's own vocabulary when available. If none exists, this fallback
|
|
99
|
+
works for governed docs:
|
|
100
|
+
|
|
101
|
+
| Need | Usually belongs in |
|
|
102
|
+
| --- | --- |
|
|
103
|
+
| AI entry and startup routing | `AGENTS.md` plus host-specific forwarders |
|
|
104
|
+
| Agents-routing rules | `docs/governance/agents-routing/` |
|
|
105
|
+
| Doc-system rules, templates, and manifest | `docs/governance/` |
|
|
106
|
+
| Project AI/development policy | `docs/policy/` |
|
|
107
|
+
| Product or feature requirement | `docs/specs/` |
|
|
108
|
+
| Step-by-step implementation work | `docs/plans/` |
|
|
109
|
+
| Durable workspace/system truth | `docs/canon/` |
|
|
110
|
+
| How-to guides, architecture maps, tool notes | `docs/reference/` |
|
|
111
|
+
| Retired governed history | `docs/archive/` |
|
|
112
|
+
| Runtime ids, values, generated asset paths | code/config/manifests, not Markdown body |
|
|
113
|
+
| Product prompts, project-package canon, generated media notes | project package or workbench, not `docs/**` by default |
|
|
114
|
+
|
|
115
|
+
If the project has different layers, use the project layers instead of this
|
|
116
|
+
table.
|
|
117
|
+
|
|
118
|
+
## Editing Rules
|
|
119
|
+
|
|
120
|
+
When modifying documentation:
|
|
121
|
+
|
|
122
|
+
1. Find the canonical source first.
|
|
123
|
+
2. Decide whether the file is a governed doc or a product artifact.
|
|
124
|
+
3. Edit only the canonical source for the durable fact.
|
|
125
|
+
4. Update navigation links if names or paths change.
|
|
126
|
+
5. Replace duplicated content with a one-line summary plus link.
|
|
127
|
+
6. If code/runtime behavior changed, update the runtime truth first, then align
|
|
128
|
+
docs.
|
|
129
|
+
7. Run the project's doc checks before claiming completion.
|
|
130
|
+
|
|
131
|
+
## Moving Or Deleting Docs
|
|
132
|
+
|
|
133
|
+
- If the content is still useful governed history, archive it under the
|
|
134
|
+
project-approved `docs/archive/**` path.
|
|
135
|
+
- If the content is stale, misleading, and already superseded, deletion can be
|
|
136
|
+
better than hoarding.
|
|
137
|
+
- Do not preserve obsolete drafts just to feel safe; excessive history increases
|
|
138
|
+
AI cognitive load.
|
|
139
|
+
- If a file is moved, update indexes, manifests, and symlinks.
|
|
140
|
+
- Do not move product artifacts into `docs/**` as a cleanup shortcut.
|
|
141
|
+
|
|
142
|
+
## Completion Checklist
|
|
143
|
+
|
|
144
|
+
Before reporting doc work complete:
|
|
145
|
+
|
|
146
|
+
- [ ] I found the project documentation system.
|
|
147
|
+
- [ ] I identified whether the changed file is governed documentation or a
|
|
148
|
+
product artifact.
|
|
149
|
+
- [ ] I updated the canonical source, not a duplicate.
|
|
150
|
+
- [ ] I did not create ungoverned temp/draft/AI-name folders under `docs/**`.
|
|
151
|
+
- [ ] I updated links/navigation after moves or renames.
|
|
152
|
+
- [ ] I kept runtime data in runtime/config files, not Markdown copies.
|
|
153
|
+
- [ ] I kept product prompts/assets in the product package unless explicitly
|
|
154
|
+
governed.
|
|
155
|
+
- [ ] I ran the project's doc validation command when available.
|
|
156
|
+
|
|
157
|
+
## Common Mistakes
|
|
158
|
+
|
|
159
|
+
| Mistake | Better move |
|
|
160
|
+
| --- | --- |
|
|
161
|
+
| Copying the same design rule into five docs | Keep one canonical doc, link from the others. |
|
|
162
|
+
| Treating old migration sources as current truth | Archive or delete them after migration. |
|
|
163
|
+
| Letting Markdown override runtime config | Runtime/config wins; docs explain intent. |
|
|
164
|
+
| Moving every `.md` file into `docs/**` | Govern discussion records; keep product artifacts in their product package. |
|
|
165
|
+
| Creating a new folder because the current structure feels inconvenient | Use the governed structure or update governance first. |
|
|
166
|
+
| Keeping outdated drafts forever | Archive only useful history; delete misleading noise. |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: REPLACE-ME
|
|
3
|
+
title: Replace Me
|
|
4
|
+
type: decision
|
|
5
|
+
status: proposed
|
|
6
|
+
canonical: true
|
|
7
|
+
owner: human
|
|
8
|
+
created: YYYY-MM-DD
|
|
9
|
+
last_reviewed: YYYY-MM-DD
|
|
10
|
+
domain: meta
|
|
11
|
+
tags:
|
|
12
|
+
- replace-me
|
|
13
|
+
pinned: false
|
|
14
|
+
related: []
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# REPLACE-ME: Replace Me
|
|
18
|
+
|
|
19
|
+
## Context
|
|
20
|
+
|
|
21
|
+
## Decision
|
|
22
|
+
|
|
23
|
+
## Consequences
|
|
24
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: REPLACE-ME
|
|
3
|
+
title: Replace Me
|
|
4
|
+
type: archive
|
|
5
|
+
status: archived
|
|
6
|
+
canonical: false
|
|
7
|
+
owner: human
|
|
8
|
+
created: YYYY-MM-DD
|
|
9
|
+
last_reviewed: YYYY-MM-DD
|
|
10
|
+
domain: archive
|
|
11
|
+
tags:
|
|
12
|
+
- replace-me
|
|
13
|
+
pinned: false
|
|
14
|
+
related: []
|
|
15
|
+
archive_reason: Replace me
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
# REPLACE-ME: Replace Me (archived)
|
|
19
|
+
|
|
20
|
+
## Archived Reason
|
|
21
|
+
|
|
22
|
+
## Historical Notes
|
|
23
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: REPLACE-ME
|
|
3
|
+
title: Replace Me
|
|
4
|
+
type: canon
|
|
5
|
+
status: draft
|
|
6
|
+
canonical: false
|
|
7
|
+
owner: human
|
|
8
|
+
created: YYYY-MM-DD
|
|
9
|
+
last_reviewed: YYYY-MM-DD
|
|
10
|
+
domain: canon
|
|
11
|
+
tags:
|
|
12
|
+
- replace-me
|
|
13
|
+
pinned: false
|
|
14
|
+
related: []
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# REPLACE-ME: Replace Me
|
|
18
|
+
|
|
19
|
+
## Current Truth
|
|
20
|
+
|
|
21
|
+
## Source / Provenance
|
|
22
|
+
|
|
23
|
+
## Open Questions
|
|
24
|
+
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: REPLACE-ME
|
|
3
|
+
title: Replace Me
|
|
4
|
+
type: plan
|
|
5
|
+
status: draft
|
|
6
|
+
canonical: false
|
|
7
|
+
owner: ai-assisted
|
|
8
|
+
created: YYYY-MM-DD
|
|
9
|
+
last_reviewed: YYYY-MM-DD
|
|
10
|
+
domain: meta
|
|
11
|
+
tags:
|
|
12
|
+
- replace-me
|
|
13
|
+
pinned: false
|
|
14
|
+
related: []
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# REPLACE-ME: Replace Me
|
|
18
|
+
|
|
19
|
+
## Goal
|
|
20
|
+
|
|
21
|
+
## Scope
|
|
22
|
+
|
|
23
|
+
## Steps
|
|
24
|
+
|
|
25
|
+
- [ ] Step 1
|
|
26
|
+
|
|
27
|
+
## Acceptance
|
|
28
|
+
|
|
29
|
+
- [ ] Verification completed
|
|
30
|
+
|
|
31
|
+
## Closeout
|
|
32
|
+
|
|
33
|
+
When complete, move this plan to `docs/plans/completed/` and set `status: completed`.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: REPLACE-ME
|
|
3
|
+
title: Replace Me
|
|
4
|
+
type: policy
|
|
5
|
+
status: draft
|
|
6
|
+
canonical: false
|
|
7
|
+
owner: human
|
|
8
|
+
created: YYYY-MM-DD
|
|
9
|
+
last_reviewed: YYYY-MM-DD
|
|
10
|
+
domain: policy
|
|
11
|
+
tags:
|
|
12
|
+
- replace-me
|
|
13
|
+
pinned: false
|
|
14
|
+
related: []
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# REPLACE-ME: Replace Me
|
|
18
|
+
|
|
19
|
+
## Rule
|
|
20
|
+
|
|
21
|
+
## Rationale
|
|
22
|
+
|
|
23
|
+
## Examples
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: REPLACE-ME
|
|
3
|
+
title: Replace Me
|
|
4
|
+
type: reference
|
|
5
|
+
status: draft
|
|
6
|
+
canonical: false
|
|
7
|
+
owner: human
|
|
8
|
+
created: YYYY-MM-DD
|
|
9
|
+
last_reviewed: YYYY-MM-DD
|
|
10
|
+
domain: reference
|
|
11
|
+
tags:
|
|
12
|
+
- replace-me
|
|
13
|
+
pinned: false
|
|
14
|
+
related: []
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# REPLACE-ME: Replace Me
|
|
18
|
+
|
|
19
|
+
## Purpose
|
|
20
|
+
|
|
21
|
+
## Details
|
|
22
|
+
|
|
23
|
+
## Related Commands / Files
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: REPLACE-ME
|
|
3
|
+
title: Replace Me
|
|
4
|
+
type: spec
|
|
5
|
+
status: draft
|
|
6
|
+
canonical: false
|
|
7
|
+
owner: human
|
|
8
|
+
created: YYYY-MM-DD
|
|
9
|
+
last_reviewed: YYYY-MM-DD
|
|
10
|
+
domain: meta
|
|
11
|
+
tags:
|
|
12
|
+
- replace-me
|
|
13
|
+
pinned: false
|
|
14
|
+
related: []
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# REPLACE-ME: Replace Me
|
|
18
|
+
|
|
19
|
+
## Problem
|
|
20
|
+
|
|
21
|
+
## Requirements
|
|
22
|
+
|
|
23
|
+
## Acceptance
|
|
24
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: POLICY-PROJECT-BEST-PRACTICE
|
|
3
|
+
title: Best Practice for This Project
|
|
4
|
+
type: policy
|
|
5
|
+
status: stable
|
|
6
|
+
canonical: true
|
|
7
|
+
owner: project
|
|
8
|
+
created: 2026-05-08
|
|
9
|
+
last_reviewed: 2026-05-08
|
|
10
|
+
domain: project-policy
|
|
11
|
+
tags:
|
|
12
|
+
- project-policy
|
|
13
|
+
- ai-development
|
|
14
|
+
pinned: true
|
|
15
|
+
related:
|
|
16
|
+
- POLICY-DOC-AGENT-RULES
|
|
17
|
+
- POLICY-DOC-TYPES
|
|
18
|
+
supersedes: []
|
|
19
|
+
superseded_by: null
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
# Best Practice for This Project
|
|
23
|
+
|
|
24
|
+
This file is project-local.
|
|
25
|
+
|
|
26
|
+
Put only project-specific rules here:
|
|
27
|
+
|
|
28
|
+
- current project truth
|
|
29
|
+
- runtime or canon truth hierarchy
|
|
30
|
+
- local lane profile
|
|
31
|
+
- verification commands
|
|
32
|
+
- asset/provenance rules
|
|
33
|
+
- current phase constraints
|
|
34
|
+
|
|
35
|
+
Do not put cross-project doc-gov core rules here.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: REF-DOCUMENTATION-MAP
|
|
3
|
+
title: Documentation Map
|
|
4
|
+
type: reference
|
|
5
|
+
status: active
|
|
6
|
+
canonical: true
|
|
7
|
+
owner: human
|
|
8
|
+
created: YYYY-MM-DD
|
|
9
|
+
last_reviewed: YYYY-MM-DD
|
|
10
|
+
domain: meta
|
|
11
|
+
tags:
|
|
12
|
+
- navigation
|
|
13
|
+
pinned: false
|
|
14
|
+
related: []
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# Documentation Map
|
|
18
|
+
|
|
19
|
+
This is a human and AI map of the governed document shelves. It is not the AI startup entrypoint; `AGENTS.md` is.
|
|
20
|
+
|
|
21
|
+
## AI Startup Source
|
|
22
|
+
|
|
23
|
+
Use `AGENTS.md` for startup reading. It should point agents to:
|
|
24
|
+
|
|
25
|
+
- `docs/policy/*.md`
|
|
26
|
+
- `docs/governance/boundary.md`
|
|
27
|
+
- `docs/governance/ssot-v0.9.md`
|
|
28
|
+
- `docs/governance/doc-agent-rules.md`
|
|
29
|
+
- `docs/governance/doc-types.md`
|
|
30
|
+
- `docs/governance/agents-routing/<selected-profile>-v0.9.md`
|
|
31
|
+
- `docs/reference/execution/current-work.md`
|
|
32
|
+
|
|
33
|
+
## Areas
|
|
34
|
+
|
|
35
|
+
| Area | Purpose |
|
|
36
|
+
| --- | --- |
|
|
37
|
+
| `docs/policy/` | Project policy and AI development rules |
|
|
38
|
+
| `docs/decisions/` | Durable decisions |
|
|
39
|
+
| `docs/specs/active/` | Active requirements |
|
|
40
|
+
| `docs/specs/completed/` | Completed specs |
|
|
41
|
+
| `docs/plans/active/` | Active implementation plans |
|
|
42
|
+
| `docs/plans/completed/` | Completed execution records |
|
|
43
|
+
| `docs/canon/` | Durable project truth |
|
|
44
|
+
| `docs/reference/` | Guides and references |
|
|
45
|
+
| `docs/archive/` | Retired history |
|
|
46
|
+
| `docs/governance/` | Governance core rules, SSOT, agents routing, doc types, templates, and manifest |
|
|
47
|
+
|
|
48
|
+
Markdown outside `docs/**` is not governed by default. Product prompts, assets,
|
|
49
|
+
project-package canon, generated media notes, and source-package files stay in
|
|
50
|
+
their product/workbench structure unless this project explicitly opts them into
|
|
51
|
+
doc-gov.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: REF-CURRENT-WORK
|
|
3
|
+
title: Current Work
|
|
4
|
+
type: reference
|
|
5
|
+
status: active
|
|
6
|
+
canonical: true
|
|
7
|
+
owner: human
|
|
8
|
+
created: YYYY-MM-DD
|
|
9
|
+
last_reviewed: YYYY-MM-DD
|
|
10
|
+
domain: meta
|
|
11
|
+
tags:
|
|
12
|
+
- current-work
|
|
13
|
+
- navigation
|
|
14
|
+
pinned: true
|
|
15
|
+
related: []
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
# Current Work
|
|
19
|
+
|
|
20
|
+
This file is the current project work index. It is not the agents-routing algorithm.
|
|
21
|
+
|
|
22
|
+
## Current Focus
|
|
23
|
+
|
|
24
|
+
- Current phase:
|
|
25
|
+
- Current active plan:
|
|
26
|
+
- Current active spec:
|
|
27
|
+
- Current proof target:
|
|
28
|
+
|
|
29
|
+
## Completed Proof History
|
|
30
|
+
|
|
31
|
+
Completed plans and specs live in:
|
|
32
|
+
|
|
33
|
+
- `docs/plans/completed/`
|
|
34
|
+
- `docs/specs/completed/`
|
|
35
|
+
|
|
36
|
+
Do not move completed work back into active. Create a new plan and link the completed record as provenance.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# lefthook.yml — Project Governance System standard doc-gov gate.
|
|
2
|
+
# Copy to target project root as lefthook.yml, then run:
|
|
3
|
+
# pnpm exec lefthook install
|
|
4
|
+
|
|
5
|
+
pre-commit:
|
|
6
|
+
parallel: false
|
|
7
|
+
commands:
|
|
8
|
+
01-doc-gov-router-check:
|
|
9
|
+
glob: "{AGENTS.md,CLAUDE.md,GEMINI.md,README.md,docs/**/*.{md,yml,yaml}}"
|
|
10
|
+
run: pnpm doc-gov router-check
|
|
11
|
+
02-doc-gov-check:
|
|
12
|
+
glob: "{docs/**/*.md,docs/governance/**/*.{md,yml,yaml},docs/policy/**/*.md,AGENTS.md,CLAUDE.md,GEMINI.md}"
|
|
13
|
+
run: pnpm doc-gov check && pnpm doc-gov scan --check && pnpm doc-gov links && pnpm doc-gov audit
|
|
14
|
+
|
|
15
|
+
commit-msg:
|
|
16
|
+
commands:
|
|
17
|
+
doc-gov-commit-msg:
|
|
18
|
+
run: pnpm doc-gov verify-commit-msg "{1}"
|
package/cli-guide.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# pro-gov CLI Guide
|
|
2
|
+
|
|
3
|
+
`pro-gov` is the project-level companion to `doc-gov`.
|
|
4
|
+
|
|
5
|
+
Use it to inspect packaged Project Governance System assets, plan a starter
|
|
6
|
+
installation, compare reusable governance files, and run package health checks.
|
|
7
|
+
|
|
8
|
+
The validator remains `doc-gov`.
|
|
9
|
+
|
|
10
|
+
## Commands
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
pro-gov assets list
|
|
14
|
+
pro-gov init --profile engineering-runtime --dry-run
|
|
15
|
+
pro-gov init --profile doc-only --dry-run
|
|
16
|
+
pro-gov sync --check
|
|
17
|
+
pro-gov doctor
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
`init` and `sync` are read-only in the first release. They report planned files,
|
|
21
|
+
missing files, or changed files, but they do not overwrite target projects.
|
|
22
|
+
|
|
23
|
+
## Typical Adoption Flow
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
pnpm add -D @pieai/pro-gov @pieai/doc-gov
|
|
27
|
+
pnpm pro-gov assets list
|
|
28
|
+
pnpm pro-gov init --profile engineering-runtime --dry-run
|
|
29
|
+
pnpm pro-gov sync --check
|
|
30
|
+
pnpm doc-gov migrate --profile engineering-runtime --check
|
|
31
|
+
pnpm doc-gov doctor
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Use `doc-only` instead of `engineering-runtime` for writing, research, IP, AI
|
|
35
|
+
media, and asset-governance workspaces that do not need runtime engineering
|
|
36
|
+
proof lanes.
|