@sandrinio/vdoc 3.3.1 → 3.4.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.
- package/package.json +1 -1
- package/skills/agents/references/exploration-strategies.md +52 -0
- package/skills/agents/references/init-workflow.md +3 -3
- package/skills/claude/references/exploration-strategies.md +52 -0
- package/skills/claude/references/init-workflow.md +3 -3
- package/skills/claude/vdoc-init.md +3 -3
- package/skills/cline/references/exploration-strategies.md +52 -0
- package/skills/cline/references/init-workflow.md +3 -3
- package/skills/continue/references/exploration-strategies.md +52 -0
- package/skills/continue/references/init-workflow.md +3 -3
- package/skills/cursor/references/exploration-strategies.md +52 -0
- package/skills/cursor/references/init-workflow.md +3 -3
- package/skills/gemini/references/exploration-strategies.md +52 -0
- package/skills/gemini/references/init-workflow.md +3 -3
- package/skills/jetbrains-ai/references/exploration-strategies.md +52 -0
- package/skills/jetbrains-ai/references/init-workflow.md +3 -3
- package/skills/junie/references/exploration-strategies.md +52 -0
- package/skills/junie/references/init-workflow.md +3 -3
- package/skills/vscode/references/exploration-strategies.md +52 -0
- package/skills/vscode/references/init-workflow.md +3 -3
- package/skills/windsurf/resources/exploration-strategies.md +52 -0
- package/skills/windsurf/resources/init-workflow.md +3 -3
package/package.json
CHANGED
|
@@ -47,6 +47,22 @@ Match the detected archetype and follow its playbook. Each defines:
|
|
|
47
47
|
- **What to extract** — what each file category reveals
|
|
48
48
|
- **Feature signals** — patterns that indicate documentable features
|
|
49
49
|
|
|
50
|
+
### Composing Archetypes
|
|
51
|
+
|
|
52
|
+
Most real projects don't fit a single archetype. **Combine playbooks** when needed:
|
|
53
|
+
|
|
54
|
+
- A FastAPI app with AI agent workflows → **Web API** playbook for routes/middleware/auth + read `**/workflows/**`, `**/agents/**`, `**/chains/**`, `**/prompts/**` for the agent layer
|
|
55
|
+
- A Next.js app with a Python microservice → **Full-Stack Framework** + **Web API** playbooks
|
|
56
|
+
- A CLI that wraps an SDK → **CLI Tool** + **Library/SDK** playbooks
|
|
57
|
+
|
|
58
|
+
**How to compose:**
|
|
59
|
+
1. Pick the **primary archetype** (what the project fundamentally is)
|
|
60
|
+
2. Follow its playbook fully
|
|
61
|
+
3. When you encounter directories/patterns that belong to another archetype, pull in that playbook's glob patterns and feature signals
|
|
62
|
+
4. In the exploration log, note which archetypes you composed and why
|
|
63
|
+
|
|
64
|
+
Do not force a project into one archetype. The playbooks are building blocks — use what fits.
|
|
65
|
+
|
|
50
66
|
---
|
|
51
67
|
|
|
52
68
|
### Web API
|
|
@@ -287,3 +303,39 @@ If the project doesn't clearly match any archetype:
|
|
|
287
303
|
5. Check CI/CD config (`.github/workflows/`, `Jenkinsfile`) — pipeline steps reveal build/deploy architecture
|
|
288
304
|
|
|
289
305
|
Then propose an archetype to the user: *"This looks like a [X] project. I'll explore it using the [X] playbook. Sound right?"*
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## Existing Documentation
|
|
310
|
+
|
|
311
|
+
During fingerprinting, check if the project already has documentation:
|
|
312
|
+
|
|
313
|
+
- `vdocs/_manifest.json` — previous vdoc output
|
|
314
|
+
- `docs/`, `documentation/`, `product_documentation/` — existing docs folder
|
|
315
|
+
- `README.md` (if substantial, beyond basic setup)
|
|
316
|
+
- `*.md` files in the project root
|
|
317
|
+
|
|
318
|
+
**If existing docs are found:**
|
|
319
|
+
|
|
320
|
+
1. **Read the existing docs first** — they are a head start, not waste
|
|
321
|
+
2. **Cross-reference with the actual codebase** — verify claims in the docs against real code. Flag anything that's:
|
|
322
|
+
- **Stale** — docs describe behavior that no longer matches the code
|
|
323
|
+
- **Missing** — code has features not covered in docs
|
|
324
|
+
- **Accurate** — docs match the code (reuse this content, don't rewrite it)
|
|
325
|
+
3. **In the exploration log**, add a section:
|
|
326
|
+
|
|
327
|
+
```markdown
|
|
328
|
+
## Existing Documentation
|
|
329
|
+
| Source | Status | Notes |
|
|
330
|
+
|--------|--------|-------|
|
|
331
|
+
| product_documentation/AUTH_DOC.md | Accurate | Matches current auth flow |
|
|
332
|
+
| product_documentation/API_DOC.md | Stale | 3 new endpoints not documented |
|
|
333
|
+
| (no existing doc) | Gap | RAG retrieval pipeline undocumented |
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
4. **In the Plan (Step 2)**, propose:
|
|
337
|
+
- **Update** for stale docs (specify what changed)
|
|
338
|
+
- **New** for gaps
|
|
339
|
+
- **Keep** for accurate docs (copy/adapt into vdocs/ format)
|
|
340
|
+
|
|
341
|
+
This avoids regenerating documentation that already exists and is correct.
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Follow the two-phase exploration strategy in `references/exploration-strategies.md`:
|
|
6
6
|
|
|
7
7
|
**Phase 1 — Fingerprint** (3-5 file reads max)
|
|
8
|
-
Read package/config files and directory structure to identify the project's language, framework, and archetype (
|
|
8
|
+
Read package/config files and directory structure to identify the project's language, framework, and archetype. Also check for existing documentation (`vdocs/`, `docs/`, `product_documentation/`, substantial `*.md` files). If found, read them first — they're a head start. See the "Existing Documentation" section in `references/exploration-strategies.md`.
|
|
9
9
|
|
|
10
10
|
**Phase 2 — Targeted Exploration** (archetype-specific)
|
|
11
|
-
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature.
|
|
11
|
+
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature. Combine multiple playbooks when the project doesn't fit a single archetype (see "Composing Archetypes" in the strategies file).
|
|
12
12
|
|
|
13
|
-
If
|
|
13
|
+
If no archetype matches, use the Fallback strategy and confirm with the user.
|
|
14
14
|
|
|
15
15
|
Do not skim. Understand how the system actually works before proposing docs.
|
|
16
16
|
|
|
@@ -47,6 +47,22 @@ Match the detected archetype and follow its playbook. Each defines:
|
|
|
47
47
|
- **What to extract** — what each file category reveals
|
|
48
48
|
- **Feature signals** — patterns that indicate documentable features
|
|
49
49
|
|
|
50
|
+
### Composing Archetypes
|
|
51
|
+
|
|
52
|
+
Most real projects don't fit a single archetype. **Combine playbooks** when needed:
|
|
53
|
+
|
|
54
|
+
- A FastAPI app with AI agent workflows → **Web API** playbook for routes/middleware/auth + read `**/workflows/**`, `**/agents/**`, `**/chains/**`, `**/prompts/**` for the agent layer
|
|
55
|
+
- A Next.js app with a Python microservice → **Full-Stack Framework** + **Web API** playbooks
|
|
56
|
+
- A CLI that wraps an SDK → **CLI Tool** + **Library/SDK** playbooks
|
|
57
|
+
|
|
58
|
+
**How to compose:**
|
|
59
|
+
1. Pick the **primary archetype** (what the project fundamentally is)
|
|
60
|
+
2. Follow its playbook fully
|
|
61
|
+
3. When you encounter directories/patterns that belong to another archetype, pull in that playbook's glob patterns and feature signals
|
|
62
|
+
4. In the exploration log, note which archetypes you composed and why
|
|
63
|
+
|
|
64
|
+
Do not force a project into one archetype. The playbooks are building blocks — use what fits.
|
|
65
|
+
|
|
50
66
|
---
|
|
51
67
|
|
|
52
68
|
### Web API
|
|
@@ -287,3 +303,39 @@ If the project doesn't clearly match any archetype:
|
|
|
287
303
|
5. Check CI/CD config (`.github/workflows/`, `Jenkinsfile`) — pipeline steps reveal build/deploy architecture
|
|
288
304
|
|
|
289
305
|
Then propose an archetype to the user: *"This looks like a [X] project. I'll explore it using the [X] playbook. Sound right?"*
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## Existing Documentation
|
|
310
|
+
|
|
311
|
+
During fingerprinting, check if the project already has documentation:
|
|
312
|
+
|
|
313
|
+
- `vdocs/_manifest.json` — previous vdoc output
|
|
314
|
+
- `docs/`, `documentation/`, `product_documentation/` — existing docs folder
|
|
315
|
+
- `README.md` (if substantial, beyond basic setup)
|
|
316
|
+
- `*.md` files in the project root
|
|
317
|
+
|
|
318
|
+
**If existing docs are found:**
|
|
319
|
+
|
|
320
|
+
1. **Read the existing docs first** — they are a head start, not waste
|
|
321
|
+
2. **Cross-reference with the actual codebase** — verify claims in the docs against real code. Flag anything that's:
|
|
322
|
+
- **Stale** — docs describe behavior that no longer matches the code
|
|
323
|
+
- **Missing** — code has features not covered in docs
|
|
324
|
+
- **Accurate** — docs match the code (reuse this content, don't rewrite it)
|
|
325
|
+
3. **In the exploration log**, add a section:
|
|
326
|
+
|
|
327
|
+
```markdown
|
|
328
|
+
## Existing Documentation
|
|
329
|
+
| Source | Status | Notes |
|
|
330
|
+
|--------|--------|-------|
|
|
331
|
+
| product_documentation/AUTH_DOC.md | Accurate | Matches current auth flow |
|
|
332
|
+
| product_documentation/API_DOC.md | Stale | 3 new endpoints not documented |
|
|
333
|
+
| (no existing doc) | Gap | RAG retrieval pipeline undocumented |
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
4. **In the Plan (Step 2)**, propose:
|
|
337
|
+
- **Update** for stale docs (specify what changed)
|
|
338
|
+
- **New** for gaps
|
|
339
|
+
- **Keep** for accurate docs (copy/adapt into vdocs/ format)
|
|
340
|
+
|
|
341
|
+
This avoids regenerating documentation that already exists and is correct.
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Follow the two-phase exploration strategy in `references/exploration-strategies.md`:
|
|
6
6
|
|
|
7
7
|
**Phase 1 — Fingerprint** (3-5 file reads max)
|
|
8
|
-
Read package/config files and directory structure to identify the project's language, framework, and archetype (
|
|
8
|
+
Read package/config files and directory structure to identify the project's language, framework, and archetype. Also check for existing documentation (`vdocs/`, `docs/`, `product_documentation/`, substantial `*.md` files). If found, read them first — they're a head start. See the "Existing Documentation" section in `references/exploration-strategies.md`.
|
|
9
9
|
|
|
10
10
|
**Phase 2 — Targeted Exploration** (archetype-specific)
|
|
11
|
-
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature.
|
|
11
|
+
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature. Combine multiple playbooks when the project doesn't fit a single archetype (see "Composing Archetypes" in the strategies file).
|
|
12
12
|
|
|
13
|
-
If
|
|
13
|
+
If no archetype matches, use the Fallback strategy and confirm with the user.
|
|
14
14
|
|
|
15
15
|
Do not skim. Understand how the system actually works before proposing docs.
|
|
16
16
|
|
|
@@ -14,12 +14,12 @@ Generate feature-centric documentation from source code. All docs go in `vdocs/`
|
|
|
14
14
|
Follow the two-phase exploration strategy in `references/exploration-strategies.md`:
|
|
15
15
|
|
|
16
16
|
**Phase 1 — Fingerprint** (3-5 file reads max)
|
|
17
|
-
Read package/config files and directory structure using Read, Glob, and Grep to identify the project's language, framework, and archetype (
|
|
17
|
+
Read package/config files and directory structure using Read, Glob, and Grep to identify the project's language, framework, and archetype. Also check for existing documentation (`vdocs/`, `docs/`, `product_documentation/`, substantial `*.md` files). If found, read them first — they're a head start. See the "Existing Documentation" section in `references/exploration-strategies.md`.
|
|
18
18
|
|
|
19
19
|
**Phase 2 — Targeted Exploration** (archetype-specific)
|
|
20
|
-
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature.
|
|
20
|
+
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature. Combine multiple playbooks when the project doesn't fit a single archetype (see "Composing Archetypes" in the strategies file).
|
|
21
21
|
|
|
22
|
-
If
|
|
22
|
+
If no archetype matches, use the Fallback strategy and confirm with the user.
|
|
23
23
|
|
|
24
24
|
Do not skim. Understand how the system actually works before proposing docs.
|
|
25
25
|
|
|
@@ -47,6 +47,22 @@ Match the detected archetype and follow its playbook. Each defines:
|
|
|
47
47
|
- **What to extract** — what each file category reveals
|
|
48
48
|
- **Feature signals** — patterns that indicate documentable features
|
|
49
49
|
|
|
50
|
+
### Composing Archetypes
|
|
51
|
+
|
|
52
|
+
Most real projects don't fit a single archetype. **Combine playbooks** when needed:
|
|
53
|
+
|
|
54
|
+
- A FastAPI app with AI agent workflows → **Web API** playbook for routes/middleware/auth + read `**/workflows/**`, `**/agents/**`, `**/chains/**`, `**/prompts/**` for the agent layer
|
|
55
|
+
- A Next.js app with a Python microservice → **Full-Stack Framework** + **Web API** playbooks
|
|
56
|
+
- A CLI that wraps an SDK → **CLI Tool** + **Library/SDK** playbooks
|
|
57
|
+
|
|
58
|
+
**How to compose:**
|
|
59
|
+
1. Pick the **primary archetype** (what the project fundamentally is)
|
|
60
|
+
2. Follow its playbook fully
|
|
61
|
+
3. When you encounter directories/patterns that belong to another archetype, pull in that playbook's glob patterns and feature signals
|
|
62
|
+
4. In the exploration log, note which archetypes you composed and why
|
|
63
|
+
|
|
64
|
+
Do not force a project into one archetype. The playbooks are building blocks — use what fits.
|
|
65
|
+
|
|
50
66
|
---
|
|
51
67
|
|
|
52
68
|
### Web API
|
|
@@ -287,3 +303,39 @@ If the project doesn't clearly match any archetype:
|
|
|
287
303
|
5. Check CI/CD config (`.github/workflows/`, `Jenkinsfile`) — pipeline steps reveal build/deploy architecture
|
|
288
304
|
|
|
289
305
|
Then propose an archetype to the user: *"This looks like a [X] project. I'll explore it using the [X] playbook. Sound right?"*
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## Existing Documentation
|
|
310
|
+
|
|
311
|
+
During fingerprinting, check if the project already has documentation:
|
|
312
|
+
|
|
313
|
+
- `vdocs/_manifest.json` — previous vdoc output
|
|
314
|
+
- `docs/`, `documentation/`, `product_documentation/` — existing docs folder
|
|
315
|
+
- `README.md` (if substantial, beyond basic setup)
|
|
316
|
+
- `*.md` files in the project root
|
|
317
|
+
|
|
318
|
+
**If existing docs are found:**
|
|
319
|
+
|
|
320
|
+
1. **Read the existing docs first** — they are a head start, not waste
|
|
321
|
+
2. **Cross-reference with the actual codebase** — verify claims in the docs against real code. Flag anything that's:
|
|
322
|
+
- **Stale** — docs describe behavior that no longer matches the code
|
|
323
|
+
- **Missing** — code has features not covered in docs
|
|
324
|
+
- **Accurate** — docs match the code (reuse this content, don't rewrite it)
|
|
325
|
+
3. **In the exploration log**, add a section:
|
|
326
|
+
|
|
327
|
+
```markdown
|
|
328
|
+
## Existing Documentation
|
|
329
|
+
| Source | Status | Notes |
|
|
330
|
+
|--------|--------|-------|
|
|
331
|
+
| product_documentation/AUTH_DOC.md | Accurate | Matches current auth flow |
|
|
332
|
+
| product_documentation/API_DOC.md | Stale | 3 new endpoints not documented |
|
|
333
|
+
| (no existing doc) | Gap | RAG retrieval pipeline undocumented |
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
4. **In the Plan (Step 2)**, propose:
|
|
337
|
+
- **Update** for stale docs (specify what changed)
|
|
338
|
+
- **New** for gaps
|
|
339
|
+
- **Keep** for accurate docs (copy/adapt into vdocs/ format)
|
|
340
|
+
|
|
341
|
+
This avoids regenerating documentation that already exists and is correct.
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Follow the two-phase exploration strategy in `references/exploration-strategies.md`:
|
|
6
6
|
|
|
7
7
|
**Phase 1 — Fingerprint** (3-5 file reads max)
|
|
8
|
-
Read package/config files and directory structure to identify the project's language, framework, and archetype (
|
|
8
|
+
Read package/config files and directory structure to identify the project's language, framework, and archetype. Also check for existing documentation (`vdocs/`, `docs/`, `product_documentation/`, substantial `*.md` files). If found, read them first — they're a head start. See the "Existing Documentation" section in `references/exploration-strategies.md`.
|
|
9
9
|
|
|
10
10
|
**Phase 2 — Targeted Exploration** (archetype-specific)
|
|
11
|
-
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature.
|
|
11
|
+
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature. Combine multiple playbooks when the project doesn't fit a single archetype (see "Composing Archetypes" in the strategies file).
|
|
12
12
|
|
|
13
|
-
If
|
|
13
|
+
If no archetype matches, use the Fallback strategy and confirm with the user.
|
|
14
14
|
|
|
15
15
|
Do not skim. Understand how the system actually works before proposing docs.
|
|
16
16
|
|
|
@@ -47,6 +47,22 @@ Match the detected archetype and follow its playbook. Each defines:
|
|
|
47
47
|
- **What to extract** — what each file category reveals
|
|
48
48
|
- **Feature signals** — patterns that indicate documentable features
|
|
49
49
|
|
|
50
|
+
### Composing Archetypes
|
|
51
|
+
|
|
52
|
+
Most real projects don't fit a single archetype. **Combine playbooks** when needed:
|
|
53
|
+
|
|
54
|
+
- A FastAPI app with AI agent workflows → **Web API** playbook for routes/middleware/auth + read `**/workflows/**`, `**/agents/**`, `**/chains/**`, `**/prompts/**` for the agent layer
|
|
55
|
+
- A Next.js app with a Python microservice → **Full-Stack Framework** + **Web API** playbooks
|
|
56
|
+
- A CLI that wraps an SDK → **CLI Tool** + **Library/SDK** playbooks
|
|
57
|
+
|
|
58
|
+
**How to compose:**
|
|
59
|
+
1. Pick the **primary archetype** (what the project fundamentally is)
|
|
60
|
+
2. Follow its playbook fully
|
|
61
|
+
3. When you encounter directories/patterns that belong to another archetype, pull in that playbook's glob patterns and feature signals
|
|
62
|
+
4. In the exploration log, note which archetypes you composed and why
|
|
63
|
+
|
|
64
|
+
Do not force a project into one archetype. The playbooks are building blocks — use what fits.
|
|
65
|
+
|
|
50
66
|
---
|
|
51
67
|
|
|
52
68
|
### Web API
|
|
@@ -287,3 +303,39 @@ If the project doesn't clearly match any archetype:
|
|
|
287
303
|
5. Check CI/CD config (`.github/workflows/`, `Jenkinsfile`) — pipeline steps reveal build/deploy architecture
|
|
288
304
|
|
|
289
305
|
Then propose an archetype to the user: *"This looks like a [X] project. I'll explore it using the [X] playbook. Sound right?"*
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## Existing Documentation
|
|
310
|
+
|
|
311
|
+
During fingerprinting, check if the project already has documentation:
|
|
312
|
+
|
|
313
|
+
- `vdocs/_manifest.json` — previous vdoc output
|
|
314
|
+
- `docs/`, `documentation/`, `product_documentation/` — existing docs folder
|
|
315
|
+
- `README.md` (if substantial, beyond basic setup)
|
|
316
|
+
- `*.md` files in the project root
|
|
317
|
+
|
|
318
|
+
**If existing docs are found:**
|
|
319
|
+
|
|
320
|
+
1. **Read the existing docs first** — they are a head start, not waste
|
|
321
|
+
2. **Cross-reference with the actual codebase** — verify claims in the docs against real code. Flag anything that's:
|
|
322
|
+
- **Stale** — docs describe behavior that no longer matches the code
|
|
323
|
+
- **Missing** — code has features not covered in docs
|
|
324
|
+
- **Accurate** — docs match the code (reuse this content, don't rewrite it)
|
|
325
|
+
3. **In the exploration log**, add a section:
|
|
326
|
+
|
|
327
|
+
```markdown
|
|
328
|
+
## Existing Documentation
|
|
329
|
+
| Source | Status | Notes |
|
|
330
|
+
|--------|--------|-------|
|
|
331
|
+
| product_documentation/AUTH_DOC.md | Accurate | Matches current auth flow |
|
|
332
|
+
| product_documentation/API_DOC.md | Stale | 3 new endpoints not documented |
|
|
333
|
+
| (no existing doc) | Gap | RAG retrieval pipeline undocumented |
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
4. **In the Plan (Step 2)**, propose:
|
|
337
|
+
- **Update** for stale docs (specify what changed)
|
|
338
|
+
- **New** for gaps
|
|
339
|
+
- **Keep** for accurate docs (copy/adapt into vdocs/ format)
|
|
340
|
+
|
|
341
|
+
This avoids regenerating documentation that already exists and is correct.
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Follow the two-phase exploration strategy in `references/exploration-strategies.md`:
|
|
6
6
|
|
|
7
7
|
**Phase 1 — Fingerprint** (3-5 file reads max)
|
|
8
|
-
Read package/config files and directory structure to identify the project's language, framework, and archetype (
|
|
8
|
+
Read package/config files and directory structure to identify the project's language, framework, and archetype. Also check for existing documentation (`vdocs/`, `docs/`, `product_documentation/`, substantial `*.md` files). If found, read them first — they're a head start. See the "Existing Documentation" section in `references/exploration-strategies.md`.
|
|
9
9
|
|
|
10
10
|
**Phase 2 — Targeted Exploration** (archetype-specific)
|
|
11
|
-
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature.
|
|
11
|
+
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature. Combine multiple playbooks when the project doesn't fit a single archetype (see "Composing Archetypes" in the strategies file).
|
|
12
12
|
|
|
13
|
-
If
|
|
13
|
+
If no archetype matches, use the Fallback strategy and confirm with the user.
|
|
14
14
|
|
|
15
15
|
Do not skim. Understand how the system actually works before proposing docs.
|
|
16
16
|
|
|
@@ -47,6 +47,22 @@ Match the detected archetype and follow its playbook. Each defines:
|
|
|
47
47
|
- **What to extract** — what each file category reveals
|
|
48
48
|
- **Feature signals** — patterns that indicate documentable features
|
|
49
49
|
|
|
50
|
+
### Composing Archetypes
|
|
51
|
+
|
|
52
|
+
Most real projects don't fit a single archetype. **Combine playbooks** when needed:
|
|
53
|
+
|
|
54
|
+
- A FastAPI app with AI agent workflows → **Web API** playbook for routes/middleware/auth + read `**/workflows/**`, `**/agents/**`, `**/chains/**`, `**/prompts/**` for the agent layer
|
|
55
|
+
- A Next.js app with a Python microservice → **Full-Stack Framework** + **Web API** playbooks
|
|
56
|
+
- A CLI that wraps an SDK → **CLI Tool** + **Library/SDK** playbooks
|
|
57
|
+
|
|
58
|
+
**How to compose:**
|
|
59
|
+
1. Pick the **primary archetype** (what the project fundamentally is)
|
|
60
|
+
2. Follow its playbook fully
|
|
61
|
+
3. When you encounter directories/patterns that belong to another archetype, pull in that playbook's glob patterns and feature signals
|
|
62
|
+
4. In the exploration log, note which archetypes you composed and why
|
|
63
|
+
|
|
64
|
+
Do not force a project into one archetype. The playbooks are building blocks — use what fits.
|
|
65
|
+
|
|
50
66
|
---
|
|
51
67
|
|
|
52
68
|
### Web API
|
|
@@ -287,3 +303,39 @@ If the project doesn't clearly match any archetype:
|
|
|
287
303
|
5. Check CI/CD config (`.github/workflows/`, `Jenkinsfile`) — pipeline steps reveal build/deploy architecture
|
|
288
304
|
|
|
289
305
|
Then propose an archetype to the user: *"This looks like a [X] project. I'll explore it using the [X] playbook. Sound right?"*
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## Existing Documentation
|
|
310
|
+
|
|
311
|
+
During fingerprinting, check if the project already has documentation:
|
|
312
|
+
|
|
313
|
+
- `vdocs/_manifest.json` — previous vdoc output
|
|
314
|
+
- `docs/`, `documentation/`, `product_documentation/` — existing docs folder
|
|
315
|
+
- `README.md` (if substantial, beyond basic setup)
|
|
316
|
+
- `*.md` files in the project root
|
|
317
|
+
|
|
318
|
+
**If existing docs are found:**
|
|
319
|
+
|
|
320
|
+
1. **Read the existing docs first** — they are a head start, not waste
|
|
321
|
+
2. **Cross-reference with the actual codebase** — verify claims in the docs against real code. Flag anything that's:
|
|
322
|
+
- **Stale** — docs describe behavior that no longer matches the code
|
|
323
|
+
- **Missing** — code has features not covered in docs
|
|
324
|
+
- **Accurate** — docs match the code (reuse this content, don't rewrite it)
|
|
325
|
+
3. **In the exploration log**, add a section:
|
|
326
|
+
|
|
327
|
+
```markdown
|
|
328
|
+
## Existing Documentation
|
|
329
|
+
| Source | Status | Notes |
|
|
330
|
+
|--------|--------|-------|
|
|
331
|
+
| product_documentation/AUTH_DOC.md | Accurate | Matches current auth flow |
|
|
332
|
+
| product_documentation/API_DOC.md | Stale | 3 new endpoints not documented |
|
|
333
|
+
| (no existing doc) | Gap | RAG retrieval pipeline undocumented |
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
4. **In the Plan (Step 2)**, propose:
|
|
337
|
+
- **Update** for stale docs (specify what changed)
|
|
338
|
+
- **New** for gaps
|
|
339
|
+
- **Keep** for accurate docs (copy/adapt into vdocs/ format)
|
|
340
|
+
|
|
341
|
+
This avoids regenerating documentation that already exists and is correct.
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Follow the two-phase exploration strategy in `references/exploration-strategies.md`:
|
|
6
6
|
|
|
7
7
|
**Phase 1 — Fingerprint** (3-5 file reads max)
|
|
8
|
-
Read package/config files and directory structure to identify the project's language, framework, and archetype (
|
|
8
|
+
Read package/config files and directory structure to identify the project's language, framework, and archetype. Also check for existing documentation (`vdocs/`, `docs/`, `product_documentation/`, substantial `*.md` files). If found, read them first — they're a head start. See the "Existing Documentation" section in `references/exploration-strategies.md`.
|
|
9
9
|
|
|
10
10
|
**Phase 2 — Targeted Exploration** (archetype-specific)
|
|
11
|
-
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature.
|
|
11
|
+
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature. Combine multiple playbooks when the project doesn't fit a single archetype (see "Composing Archetypes" in the strategies file).
|
|
12
12
|
|
|
13
|
-
If
|
|
13
|
+
If no archetype matches, use the Fallback strategy and confirm with the user.
|
|
14
14
|
|
|
15
15
|
Do not skim. Understand how the system actually works before proposing docs.
|
|
16
16
|
|
|
@@ -47,6 +47,22 @@ Match the detected archetype and follow its playbook. Each defines:
|
|
|
47
47
|
- **What to extract** — what each file category reveals
|
|
48
48
|
- **Feature signals** — patterns that indicate documentable features
|
|
49
49
|
|
|
50
|
+
### Composing Archetypes
|
|
51
|
+
|
|
52
|
+
Most real projects don't fit a single archetype. **Combine playbooks** when needed:
|
|
53
|
+
|
|
54
|
+
- A FastAPI app with AI agent workflows → **Web API** playbook for routes/middleware/auth + read `**/workflows/**`, `**/agents/**`, `**/chains/**`, `**/prompts/**` for the agent layer
|
|
55
|
+
- A Next.js app with a Python microservice → **Full-Stack Framework** + **Web API** playbooks
|
|
56
|
+
- A CLI that wraps an SDK → **CLI Tool** + **Library/SDK** playbooks
|
|
57
|
+
|
|
58
|
+
**How to compose:**
|
|
59
|
+
1. Pick the **primary archetype** (what the project fundamentally is)
|
|
60
|
+
2. Follow its playbook fully
|
|
61
|
+
3. When you encounter directories/patterns that belong to another archetype, pull in that playbook's glob patterns and feature signals
|
|
62
|
+
4. In the exploration log, note which archetypes you composed and why
|
|
63
|
+
|
|
64
|
+
Do not force a project into one archetype. The playbooks are building blocks — use what fits.
|
|
65
|
+
|
|
50
66
|
---
|
|
51
67
|
|
|
52
68
|
### Web API
|
|
@@ -287,3 +303,39 @@ If the project doesn't clearly match any archetype:
|
|
|
287
303
|
5. Check CI/CD config (`.github/workflows/`, `Jenkinsfile`) — pipeline steps reveal build/deploy architecture
|
|
288
304
|
|
|
289
305
|
Then propose an archetype to the user: *"This looks like a [X] project. I'll explore it using the [X] playbook. Sound right?"*
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## Existing Documentation
|
|
310
|
+
|
|
311
|
+
During fingerprinting, check if the project already has documentation:
|
|
312
|
+
|
|
313
|
+
- `vdocs/_manifest.json` — previous vdoc output
|
|
314
|
+
- `docs/`, `documentation/`, `product_documentation/` — existing docs folder
|
|
315
|
+
- `README.md` (if substantial, beyond basic setup)
|
|
316
|
+
- `*.md` files in the project root
|
|
317
|
+
|
|
318
|
+
**If existing docs are found:**
|
|
319
|
+
|
|
320
|
+
1. **Read the existing docs first** — they are a head start, not waste
|
|
321
|
+
2. **Cross-reference with the actual codebase** — verify claims in the docs against real code. Flag anything that's:
|
|
322
|
+
- **Stale** — docs describe behavior that no longer matches the code
|
|
323
|
+
- **Missing** — code has features not covered in docs
|
|
324
|
+
- **Accurate** — docs match the code (reuse this content, don't rewrite it)
|
|
325
|
+
3. **In the exploration log**, add a section:
|
|
326
|
+
|
|
327
|
+
```markdown
|
|
328
|
+
## Existing Documentation
|
|
329
|
+
| Source | Status | Notes |
|
|
330
|
+
|--------|--------|-------|
|
|
331
|
+
| product_documentation/AUTH_DOC.md | Accurate | Matches current auth flow |
|
|
332
|
+
| product_documentation/API_DOC.md | Stale | 3 new endpoints not documented |
|
|
333
|
+
| (no existing doc) | Gap | RAG retrieval pipeline undocumented |
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
4. **In the Plan (Step 2)**, propose:
|
|
337
|
+
- **Update** for stale docs (specify what changed)
|
|
338
|
+
- **New** for gaps
|
|
339
|
+
- **Keep** for accurate docs (copy/adapt into vdocs/ format)
|
|
340
|
+
|
|
341
|
+
This avoids regenerating documentation that already exists and is correct.
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Follow the two-phase exploration strategy in `references/exploration-strategies.md`:
|
|
6
6
|
|
|
7
7
|
**Phase 1 — Fingerprint** (3-5 file reads max)
|
|
8
|
-
Read package/config files and directory structure to identify the project's language, framework, and archetype (
|
|
8
|
+
Read package/config files and directory structure to identify the project's language, framework, and archetype. Also check for existing documentation (`vdocs/`, `docs/`, `product_documentation/`, substantial `*.md` files). If found, read them first — they're a head start. See the "Existing Documentation" section in `references/exploration-strategies.md`.
|
|
9
9
|
|
|
10
10
|
**Phase 2 — Targeted Exploration** (archetype-specific)
|
|
11
|
-
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature.
|
|
11
|
+
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature. Combine multiple playbooks when the project doesn't fit a single archetype (see "Composing Archetypes" in the strategies file).
|
|
12
12
|
|
|
13
|
-
If
|
|
13
|
+
If no archetype matches, use the Fallback strategy and confirm with the user.
|
|
14
14
|
|
|
15
15
|
Do not skim. Understand how the system actually works before proposing docs.
|
|
16
16
|
|
|
@@ -47,6 +47,22 @@ Match the detected archetype and follow its playbook. Each defines:
|
|
|
47
47
|
- **What to extract** — what each file category reveals
|
|
48
48
|
- **Feature signals** — patterns that indicate documentable features
|
|
49
49
|
|
|
50
|
+
### Composing Archetypes
|
|
51
|
+
|
|
52
|
+
Most real projects don't fit a single archetype. **Combine playbooks** when needed:
|
|
53
|
+
|
|
54
|
+
- A FastAPI app with AI agent workflows → **Web API** playbook for routes/middleware/auth + read `**/workflows/**`, `**/agents/**`, `**/chains/**`, `**/prompts/**` for the agent layer
|
|
55
|
+
- A Next.js app with a Python microservice → **Full-Stack Framework** + **Web API** playbooks
|
|
56
|
+
- A CLI that wraps an SDK → **CLI Tool** + **Library/SDK** playbooks
|
|
57
|
+
|
|
58
|
+
**How to compose:**
|
|
59
|
+
1. Pick the **primary archetype** (what the project fundamentally is)
|
|
60
|
+
2. Follow its playbook fully
|
|
61
|
+
3. When you encounter directories/patterns that belong to another archetype, pull in that playbook's glob patterns and feature signals
|
|
62
|
+
4. In the exploration log, note which archetypes you composed and why
|
|
63
|
+
|
|
64
|
+
Do not force a project into one archetype. The playbooks are building blocks — use what fits.
|
|
65
|
+
|
|
50
66
|
---
|
|
51
67
|
|
|
52
68
|
### Web API
|
|
@@ -287,3 +303,39 @@ If the project doesn't clearly match any archetype:
|
|
|
287
303
|
5. Check CI/CD config (`.github/workflows/`, `Jenkinsfile`) — pipeline steps reveal build/deploy architecture
|
|
288
304
|
|
|
289
305
|
Then propose an archetype to the user: *"This looks like a [X] project. I'll explore it using the [X] playbook. Sound right?"*
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## Existing Documentation
|
|
310
|
+
|
|
311
|
+
During fingerprinting, check if the project already has documentation:
|
|
312
|
+
|
|
313
|
+
- `vdocs/_manifest.json` — previous vdoc output
|
|
314
|
+
- `docs/`, `documentation/`, `product_documentation/` — existing docs folder
|
|
315
|
+
- `README.md` (if substantial, beyond basic setup)
|
|
316
|
+
- `*.md` files in the project root
|
|
317
|
+
|
|
318
|
+
**If existing docs are found:**
|
|
319
|
+
|
|
320
|
+
1. **Read the existing docs first** — they are a head start, not waste
|
|
321
|
+
2. **Cross-reference with the actual codebase** — verify claims in the docs against real code. Flag anything that's:
|
|
322
|
+
- **Stale** — docs describe behavior that no longer matches the code
|
|
323
|
+
- **Missing** — code has features not covered in docs
|
|
324
|
+
- **Accurate** — docs match the code (reuse this content, don't rewrite it)
|
|
325
|
+
3. **In the exploration log**, add a section:
|
|
326
|
+
|
|
327
|
+
```markdown
|
|
328
|
+
## Existing Documentation
|
|
329
|
+
| Source | Status | Notes |
|
|
330
|
+
|--------|--------|-------|
|
|
331
|
+
| product_documentation/AUTH_DOC.md | Accurate | Matches current auth flow |
|
|
332
|
+
| product_documentation/API_DOC.md | Stale | 3 new endpoints not documented |
|
|
333
|
+
| (no existing doc) | Gap | RAG retrieval pipeline undocumented |
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
4. **In the Plan (Step 2)**, propose:
|
|
337
|
+
- **Update** for stale docs (specify what changed)
|
|
338
|
+
- **New** for gaps
|
|
339
|
+
- **Keep** for accurate docs (copy/adapt into vdocs/ format)
|
|
340
|
+
|
|
341
|
+
This avoids regenerating documentation that already exists and is correct.
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Follow the two-phase exploration strategy in `references/exploration-strategies.md`:
|
|
6
6
|
|
|
7
7
|
**Phase 1 — Fingerprint** (3-5 file reads max)
|
|
8
|
-
Read package/config files and directory structure to identify the project's language, framework, and archetype (
|
|
8
|
+
Read package/config files and directory structure to identify the project's language, framework, and archetype. Also check for existing documentation (`vdocs/`, `docs/`, `product_documentation/`, substantial `*.md` files). If found, read them first — they're a head start. See the "Existing Documentation" section in `references/exploration-strategies.md`.
|
|
9
9
|
|
|
10
10
|
**Phase 2 — Targeted Exploration** (archetype-specific)
|
|
11
|
-
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature.
|
|
11
|
+
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature. Combine multiple playbooks when the project doesn't fit a single archetype (see "Composing Archetypes" in the strategies file).
|
|
12
12
|
|
|
13
|
-
If
|
|
13
|
+
If no archetype matches, use the Fallback strategy and confirm with the user.
|
|
14
14
|
|
|
15
15
|
Do not skim. Understand how the system actually works before proposing docs.
|
|
16
16
|
|
|
@@ -47,6 +47,22 @@ Match the detected archetype and follow its playbook. Each defines:
|
|
|
47
47
|
- **What to extract** — what each file category reveals
|
|
48
48
|
- **Feature signals** — patterns that indicate documentable features
|
|
49
49
|
|
|
50
|
+
### Composing Archetypes
|
|
51
|
+
|
|
52
|
+
Most real projects don't fit a single archetype. **Combine playbooks** when needed:
|
|
53
|
+
|
|
54
|
+
- A FastAPI app with AI agent workflows → **Web API** playbook for routes/middleware/auth + read `**/workflows/**`, `**/agents/**`, `**/chains/**`, `**/prompts/**` for the agent layer
|
|
55
|
+
- A Next.js app with a Python microservice → **Full-Stack Framework** + **Web API** playbooks
|
|
56
|
+
- A CLI that wraps an SDK → **CLI Tool** + **Library/SDK** playbooks
|
|
57
|
+
|
|
58
|
+
**How to compose:**
|
|
59
|
+
1. Pick the **primary archetype** (what the project fundamentally is)
|
|
60
|
+
2. Follow its playbook fully
|
|
61
|
+
3. When you encounter directories/patterns that belong to another archetype, pull in that playbook's glob patterns and feature signals
|
|
62
|
+
4. In the exploration log, note which archetypes you composed and why
|
|
63
|
+
|
|
64
|
+
Do not force a project into one archetype. The playbooks are building blocks — use what fits.
|
|
65
|
+
|
|
50
66
|
---
|
|
51
67
|
|
|
52
68
|
### Web API
|
|
@@ -287,3 +303,39 @@ If the project doesn't clearly match any archetype:
|
|
|
287
303
|
5. Check CI/CD config (`.github/workflows/`, `Jenkinsfile`) — pipeline steps reveal build/deploy architecture
|
|
288
304
|
|
|
289
305
|
Then propose an archetype to the user: *"This looks like a [X] project. I'll explore it using the [X] playbook. Sound right?"*
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## Existing Documentation
|
|
310
|
+
|
|
311
|
+
During fingerprinting, check if the project already has documentation:
|
|
312
|
+
|
|
313
|
+
- `vdocs/_manifest.json` — previous vdoc output
|
|
314
|
+
- `docs/`, `documentation/`, `product_documentation/` — existing docs folder
|
|
315
|
+
- `README.md` (if substantial, beyond basic setup)
|
|
316
|
+
- `*.md` files in the project root
|
|
317
|
+
|
|
318
|
+
**If existing docs are found:**
|
|
319
|
+
|
|
320
|
+
1. **Read the existing docs first** — they are a head start, not waste
|
|
321
|
+
2. **Cross-reference with the actual codebase** — verify claims in the docs against real code. Flag anything that's:
|
|
322
|
+
- **Stale** — docs describe behavior that no longer matches the code
|
|
323
|
+
- **Missing** — code has features not covered in docs
|
|
324
|
+
- **Accurate** — docs match the code (reuse this content, don't rewrite it)
|
|
325
|
+
3. **In the exploration log**, add a section:
|
|
326
|
+
|
|
327
|
+
```markdown
|
|
328
|
+
## Existing Documentation
|
|
329
|
+
| Source | Status | Notes |
|
|
330
|
+
|--------|--------|-------|
|
|
331
|
+
| product_documentation/AUTH_DOC.md | Accurate | Matches current auth flow |
|
|
332
|
+
| product_documentation/API_DOC.md | Stale | 3 new endpoints not documented |
|
|
333
|
+
| (no existing doc) | Gap | RAG retrieval pipeline undocumented |
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
4. **In the Plan (Step 2)**, propose:
|
|
337
|
+
- **Update** for stale docs (specify what changed)
|
|
338
|
+
- **New** for gaps
|
|
339
|
+
- **Keep** for accurate docs (copy/adapt into vdocs/ format)
|
|
340
|
+
|
|
341
|
+
This avoids regenerating documentation that already exists and is correct.
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Follow the two-phase exploration strategy in `references/exploration-strategies.md`:
|
|
6
6
|
|
|
7
7
|
**Phase 1 — Fingerprint** (3-5 file reads max)
|
|
8
|
-
Read package/config files and directory structure to identify the project's language, framework, and archetype (
|
|
8
|
+
Read package/config files and directory structure to identify the project's language, framework, and archetype. Also check for existing documentation (`vdocs/`, `docs/`, `product_documentation/`, substantial `*.md` files). If found, read them first — they're a head start. See the "Existing Documentation" section in `references/exploration-strategies.md`.
|
|
9
9
|
|
|
10
10
|
**Phase 2 — Targeted Exploration** (archetype-specific)
|
|
11
|
-
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature.
|
|
11
|
+
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature. Combine multiple playbooks when the project doesn't fit a single archetype (see "Composing Archetypes" in the strategies file).
|
|
12
12
|
|
|
13
|
-
If
|
|
13
|
+
If no archetype matches, use the Fallback strategy and confirm with the user.
|
|
14
14
|
|
|
15
15
|
Do not skim. Understand how the system actually works before proposing docs.
|
|
16
16
|
|
|
@@ -47,6 +47,22 @@ Match the detected archetype and follow its playbook. Each defines:
|
|
|
47
47
|
- **What to extract** — what each file category reveals
|
|
48
48
|
- **Feature signals** — patterns that indicate documentable features
|
|
49
49
|
|
|
50
|
+
### Composing Archetypes
|
|
51
|
+
|
|
52
|
+
Most real projects don't fit a single archetype. **Combine playbooks** when needed:
|
|
53
|
+
|
|
54
|
+
- A FastAPI app with AI agent workflows → **Web API** playbook for routes/middleware/auth + read `**/workflows/**`, `**/agents/**`, `**/chains/**`, `**/prompts/**` for the agent layer
|
|
55
|
+
- A Next.js app with a Python microservice → **Full-Stack Framework** + **Web API** playbooks
|
|
56
|
+
- A CLI that wraps an SDK → **CLI Tool** + **Library/SDK** playbooks
|
|
57
|
+
|
|
58
|
+
**How to compose:**
|
|
59
|
+
1. Pick the **primary archetype** (what the project fundamentally is)
|
|
60
|
+
2. Follow its playbook fully
|
|
61
|
+
3. When you encounter directories/patterns that belong to another archetype, pull in that playbook's glob patterns and feature signals
|
|
62
|
+
4. In the exploration log, note which archetypes you composed and why
|
|
63
|
+
|
|
64
|
+
Do not force a project into one archetype. The playbooks are building blocks — use what fits.
|
|
65
|
+
|
|
50
66
|
---
|
|
51
67
|
|
|
52
68
|
### Web API
|
|
@@ -287,3 +303,39 @@ If the project doesn't clearly match any archetype:
|
|
|
287
303
|
5. Check CI/CD config (`.github/workflows/`, `Jenkinsfile`) — pipeline steps reveal build/deploy architecture
|
|
288
304
|
|
|
289
305
|
Then propose an archetype to the user: *"This looks like a [X] project. I'll explore it using the [X] playbook. Sound right?"*
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## Existing Documentation
|
|
310
|
+
|
|
311
|
+
During fingerprinting, check if the project already has documentation:
|
|
312
|
+
|
|
313
|
+
- `vdocs/_manifest.json` — previous vdoc output
|
|
314
|
+
- `docs/`, `documentation/`, `product_documentation/` — existing docs folder
|
|
315
|
+
- `README.md` (if substantial, beyond basic setup)
|
|
316
|
+
- `*.md` files in the project root
|
|
317
|
+
|
|
318
|
+
**If existing docs are found:**
|
|
319
|
+
|
|
320
|
+
1. **Read the existing docs first** — they are a head start, not waste
|
|
321
|
+
2. **Cross-reference with the actual codebase** — verify claims in the docs against real code. Flag anything that's:
|
|
322
|
+
- **Stale** — docs describe behavior that no longer matches the code
|
|
323
|
+
- **Missing** — code has features not covered in docs
|
|
324
|
+
- **Accurate** — docs match the code (reuse this content, don't rewrite it)
|
|
325
|
+
3. **In the exploration log**, add a section:
|
|
326
|
+
|
|
327
|
+
```markdown
|
|
328
|
+
## Existing Documentation
|
|
329
|
+
| Source | Status | Notes |
|
|
330
|
+
|--------|--------|-------|
|
|
331
|
+
| product_documentation/AUTH_DOC.md | Accurate | Matches current auth flow |
|
|
332
|
+
| product_documentation/API_DOC.md | Stale | 3 new endpoints not documented |
|
|
333
|
+
| (no existing doc) | Gap | RAG retrieval pipeline undocumented |
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
4. **In the Plan (Step 2)**, propose:
|
|
337
|
+
- **Update** for stale docs (specify what changed)
|
|
338
|
+
- **New** for gaps
|
|
339
|
+
- **Keep** for accurate docs (copy/adapt into vdocs/ format)
|
|
340
|
+
|
|
341
|
+
This avoids regenerating documentation that already exists and is correct.
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Follow the two-phase exploration strategy in `references/exploration-strategies.md`:
|
|
6
6
|
|
|
7
7
|
**Phase 1 — Fingerprint** (3-5 file reads max)
|
|
8
|
-
Read package/config files and directory structure to identify the project's language, framework, and archetype (
|
|
8
|
+
Read package/config files and directory structure to identify the project's language, framework, and archetype. Also check for existing documentation (`vdocs/`, `docs/`, `product_documentation/`, substantial `*.md` files). If found, read them first — they're a head start. See the "Existing Documentation" section in `references/exploration-strategies.md`.
|
|
9
9
|
|
|
10
10
|
**Phase 2 — Targeted Exploration** (archetype-specific)
|
|
11
|
-
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature.
|
|
11
|
+
Apply the matching archetype playbook from `references/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature. Combine multiple playbooks when the project doesn't fit a single archetype (see "Composing Archetypes" in the strategies file).
|
|
12
12
|
|
|
13
|
-
If
|
|
13
|
+
If no archetype matches, use the Fallback strategy and confirm with the user.
|
|
14
14
|
|
|
15
15
|
Do not skim. Understand how the system actually works before proposing docs.
|
|
16
16
|
|
|
@@ -47,6 +47,22 @@ Match the detected archetype and follow its playbook. Each defines:
|
|
|
47
47
|
- **What to extract** — what each file category reveals
|
|
48
48
|
- **Feature signals** — patterns that indicate documentable features
|
|
49
49
|
|
|
50
|
+
### Composing Archetypes
|
|
51
|
+
|
|
52
|
+
Most real projects don't fit a single archetype. **Combine playbooks** when needed:
|
|
53
|
+
|
|
54
|
+
- A FastAPI app with AI agent workflows → **Web API** playbook for routes/middleware/auth + read `**/workflows/**`, `**/agents/**`, `**/chains/**`, `**/prompts/**` for the agent layer
|
|
55
|
+
- A Next.js app with a Python microservice → **Full-Stack Framework** + **Web API** playbooks
|
|
56
|
+
- A CLI that wraps an SDK → **CLI Tool** + **Library/SDK** playbooks
|
|
57
|
+
|
|
58
|
+
**How to compose:**
|
|
59
|
+
1. Pick the **primary archetype** (what the project fundamentally is)
|
|
60
|
+
2. Follow its playbook fully
|
|
61
|
+
3. When you encounter directories/patterns that belong to another archetype, pull in that playbook's glob patterns and feature signals
|
|
62
|
+
4. In the exploration log, note which archetypes you composed and why
|
|
63
|
+
|
|
64
|
+
Do not force a project into one archetype. The playbooks are building blocks — use what fits.
|
|
65
|
+
|
|
50
66
|
---
|
|
51
67
|
|
|
52
68
|
### Web API
|
|
@@ -287,3 +303,39 @@ If the project doesn't clearly match any archetype:
|
|
|
287
303
|
5. Check CI/CD config (`.github/workflows/`, `Jenkinsfile`) — pipeline steps reveal build/deploy architecture
|
|
288
304
|
|
|
289
305
|
Then propose an archetype to the user: *"This looks like a [X] project. I'll explore it using the [X] playbook. Sound right?"*
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## Existing Documentation
|
|
310
|
+
|
|
311
|
+
During fingerprinting, check if the project already has documentation:
|
|
312
|
+
|
|
313
|
+
- `vdocs/_manifest.json` — previous vdoc output
|
|
314
|
+
- `docs/`, `documentation/`, `product_documentation/` — existing docs folder
|
|
315
|
+
- `README.md` (if substantial, beyond basic setup)
|
|
316
|
+
- `*.md` files in the project root
|
|
317
|
+
|
|
318
|
+
**If existing docs are found:**
|
|
319
|
+
|
|
320
|
+
1. **Read the existing docs first** — they are a head start, not waste
|
|
321
|
+
2. **Cross-reference with the actual codebase** — verify claims in the docs against real code. Flag anything that's:
|
|
322
|
+
- **Stale** — docs describe behavior that no longer matches the code
|
|
323
|
+
- **Missing** — code has features not covered in docs
|
|
324
|
+
- **Accurate** — docs match the code (reuse this content, don't rewrite it)
|
|
325
|
+
3. **In the exploration log**, add a section:
|
|
326
|
+
|
|
327
|
+
```markdown
|
|
328
|
+
## Existing Documentation
|
|
329
|
+
| Source | Status | Notes |
|
|
330
|
+
|--------|--------|-------|
|
|
331
|
+
| product_documentation/AUTH_DOC.md | Accurate | Matches current auth flow |
|
|
332
|
+
| product_documentation/API_DOC.md | Stale | 3 new endpoints not documented |
|
|
333
|
+
| (no existing doc) | Gap | RAG retrieval pipeline undocumented |
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
4. **In the Plan (Step 2)**, propose:
|
|
337
|
+
- **Update** for stale docs (specify what changed)
|
|
338
|
+
- **New** for gaps
|
|
339
|
+
- **Keep** for accurate docs (copy/adapt into vdocs/ format)
|
|
340
|
+
|
|
341
|
+
This avoids regenerating documentation that already exists and is correct.
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Follow the two-phase exploration strategy in `resources/exploration-strategies.md`:
|
|
6
6
|
|
|
7
7
|
**Phase 1 — Fingerprint** (3-5 file reads max)
|
|
8
|
-
Read package/config files and directory structure to identify the project's language, framework, and archetype (
|
|
8
|
+
Read package/config files and directory structure to identify the project's language, framework, and archetype. Also check for existing documentation (`vdocs/`, `docs/`, `product_documentation/`, substantial `*.md` files). If found, read them first — they're a head start. See the "Existing Documentation" section in `resources/exploration-strategies.md`.
|
|
9
9
|
|
|
10
10
|
**Phase 2 — Targeted Exploration** (archetype-specific)
|
|
11
|
-
Apply the matching archetype playbook from `resources/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature.
|
|
11
|
+
Apply the matching archetype playbook from `resources/exploration-strategies.md`. Read files in priority order using the glob patterns listed. Identify feature signals — each signal maps to a documentable feature. Combine multiple playbooks when the project doesn't fit a single archetype (see "Composing Archetypes" in the strategies file).
|
|
12
12
|
|
|
13
|
-
If
|
|
13
|
+
If no archetype matches, use the Fallback strategy and confirm with the user.
|
|
14
14
|
|
|
15
15
|
Do not skim. Understand how the system actually works before proposing docs.
|
|
16
16
|
|