@sandrinio/vdoc 3.0.0 → 3.3.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.
Files changed (72) hide show
  1. package/README.md +13 -13
  2. package/bin/vdoc.mjs +78 -9
  3. package/package.json +1 -1
  4. package/skills/agents/AGENTS.md +17 -143
  5. package/skills/agents/references/audit-workflow.md +65 -0
  6. package/skills/agents/references/doc-template.md +67 -0
  7. package/skills/agents/references/exploration-strategies.md +289 -0
  8. package/skills/agents/references/init-workflow.md +123 -0
  9. package/skills/agents/references/manifest-schema.json +16 -0
  10. package/skills/claude/SKILL.md +14 -198
  11. package/skills/claude/references/audit-workflow.md +65 -0
  12. package/skills/claude/references/exploration-strategies.md +289 -0
  13. package/skills/claude/references/init-workflow.md +123 -0
  14. package/skills/claude/vdoc-audit.md +80 -0
  15. package/skills/claude/vdoc-init.md +216 -0
  16. package/skills/cline/references/audit-workflow.md +65 -0
  17. package/skills/cline/references/doc-template.md +67 -0
  18. package/skills/cline/references/exploration-strategies.md +289 -0
  19. package/skills/cline/references/init-workflow.md +123 -0
  20. package/skills/cline/references/manifest-schema.json +16 -0
  21. package/skills/cline/vdoc-workflow.md +3 -13
  22. package/skills/cline/vdoc.md +10 -148
  23. package/skills/continue/references/audit-workflow.md +65 -0
  24. package/skills/continue/references/doc-template.md +67 -0
  25. package/skills/continue/references/exploration-strategies.md +289 -0
  26. package/skills/continue/references/init-workflow.md +123 -0
  27. package/skills/continue/references/manifest-schema.json +16 -0
  28. package/skills/continue/vdoc-command.md +3 -13
  29. package/skills/continue/vdoc.md +9 -147
  30. package/skills/cursor/RULE.md +68 -0
  31. package/skills/cursor/references/audit-workflow.md +65 -0
  32. package/skills/cursor/references/doc-template.md +67 -0
  33. package/skills/cursor/references/exploration-strategies.md +289 -0
  34. package/skills/cursor/references/init-workflow.md +123 -0
  35. package/skills/cursor/references/manifest-schema.json +16 -0
  36. package/skills/cursor/vdoc-command.md +3 -13
  37. package/skills/gemini/GEMINI.md +17 -143
  38. package/skills/gemini/references/audit-workflow.md +65 -0
  39. package/skills/gemini/references/doc-template.md +67 -0
  40. package/skills/gemini/references/exploration-strategies.md +289 -0
  41. package/skills/gemini/references/init-workflow.md +123 -0
  42. package/skills/gemini/references/manifest-schema.json +16 -0
  43. package/skills/gemini/vdoc.toml +3 -9
  44. package/skills/jetbrains-ai/references/audit-workflow.md +65 -0
  45. package/skills/jetbrains-ai/references/doc-template.md +67 -0
  46. package/skills/jetbrains-ai/references/exploration-strategies.md +289 -0
  47. package/skills/jetbrains-ai/references/init-workflow.md +123 -0
  48. package/skills/jetbrains-ai/references/manifest-schema.json +16 -0
  49. package/skills/jetbrains-ai/vdoc.md +17 -143
  50. package/skills/junie/guidelines.md +17 -143
  51. package/skills/junie/references/audit-workflow.md +65 -0
  52. package/skills/junie/references/doc-template.md +67 -0
  53. package/skills/junie/references/exploration-strategies.md +289 -0
  54. package/skills/junie/references/init-workflow.md +123 -0
  55. package/skills/junie/references/manifest-schema.json +16 -0
  56. package/skills/vscode/SKILL.md +39 -0
  57. package/skills/vscode/references/audit-workflow.md +65 -0
  58. package/skills/vscode/references/doc-template.md +67 -0
  59. package/skills/vscode/references/exploration-strategies.md +289 -0
  60. package/skills/vscode/references/init-workflow.md +123 -0
  61. package/skills/vscode/references/manifest-schema.json +16 -0
  62. package/skills/vscode/vdoc.instructions.md +30 -146
  63. package/skills/vscode/vdoc.prompt.md +5 -15
  64. package/skills/windsurf/SKILL.md +67 -0
  65. package/skills/windsurf/resources/audit-workflow.md +65 -0
  66. package/skills/windsurf/resources/doc-template.md +67 -0
  67. package/skills/windsurf/resources/exploration-strategies.md +289 -0
  68. package/skills/windsurf/resources/init-workflow.md +123 -0
  69. package/skills/windsurf/resources/manifest-schema.json +16 -0
  70. package/skills/windsurf/vdoc-workflow.md +3 -13
  71. package/skills/cursor/vdoc.mdc +0 -176
  72. package/skills/windsurf/vdoc.md +0 -94
@@ -0,0 +1,289 @@
1
+ # Exploration Strategies
2
+
3
+ Smart, targeted codebase exploration. Two phases: fingerprint the project, then follow the right archetype playbook.
4
+
5
+ ## Phase 1 — Fingerprint
6
+
7
+ Read these high-signal files first (whichever exist) to classify the project. **3-5 reads max.**
8
+
9
+ ### Package / Config Files (read 1-2)
10
+
11
+ | File | Ecosystem |
12
+ |------|-----------|
13
+ | `package.json` | Node.js / JavaScript / TypeScript |
14
+ | `pyproject.toml` / `setup.py` / `requirements.txt` | Python |
15
+ | `go.mod` | Go |
16
+ | `Cargo.toml` | Rust |
17
+ | `Gemfile` | Ruby |
18
+ | `pom.xml` / `build.gradle` | Java / Kotlin |
19
+ | `composer.json` | PHP |
20
+ | `*.csproj` / `*.sln` | .NET |
21
+ | `pubspec.yaml` | Dart / Flutter |
22
+
23
+ ### Structure Scan
24
+
25
+ - List root directory
26
+ - List `src/` or `app/` or `lib/` (whichever exists)
27
+
28
+ ### Entry Points (read 1-2)
29
+
30
+ - README.md (first 50 lines)
31
+ - Main entry file (e.g., `src/index.ts`, `main.py`, `cmd/main.go`)
32
+
33
+ ### Determine
34
+
35
+ 1. **Primary language(s)** and framework(s)
36
+ 2. **Project archetype** — match to a playbook below
37
+ 3. **Rough scope** — small (< 20 files), medium (20-100), large (100+)
38
+
39
+ If the project spans multiple archetypes (e.g., monorepo with frontend + API), apply multiple playbooks.
40
+
41
+ ---
42
+
43
+ ## Phase 2 — Archetype Playbooks
44
+
45
+ Match the detected archetype and follow its playbook. Each defines:
46
+ - **Glob patterns** — files to read, in priority order
47
+ - **What to extract** — what each file category reveals
48
+ - **Feature signals** — patterns that indicate documentable features
49
+
50
+ ---
51
+
52
+ ### Web API
53
+
54
+ **Signals:** Express, FastAPI, Django REST, Rails, Spring Boot, Gin, Actix, Phoenix, Hono, NestJS
55
+
56
+ | Priority | Glob Pattern | What to Extract |
57
+ |----------|-------------|-----------------|
58
+ | 1 | `**/routes/**`, `**/router.*`, `**/urls.py` | Endpoints, HTTP methods, URL structure |
59
+ | 2 | `**/middleware/**`, `**/middleware.*` | Auth, CORS, rate limiting, logging, error handling |
60
+ | 3 | `**/models/**`, `**/schema*`, `**/migrations/**` | Data model, entities, relationships |
61
+ | 4 | `**/controllers/**`, `**/handlers/**`, `**/views/**` | Business logic per endpoint |
62
+ | 5 | `**/services/**`, `**/lib/**` | Shared logic, external integrations |
63
+ | 6 | `**/config/**`, `.env*`, `**/settings*` | Environment config, feature flags |
64
+ | 7 | `**/tests/**` (skim 2-3) | What's tested reveals what matters |
65
+
66
+ **Feature signals:**
67
+ - Auth routes/middleware → Authentication doc
68
+ - Payment/billing routes → Payments doc
69
+ - File upload handlers → File Management doc
70
+ - WebSocket/SSE handlers → Real-time doc
71
+ - Background jobs/queues → Background Processing doc
72
+ - Email/notification services → Notifications doc
73
+ - Search endpoints → Search doc
74
+ - Admin routes → Admin Panel doc
75
+
76
+ ---
77
+
78
+ ### Frontend SPA
79
+
80
+ **Signals:** React (CRA/Vite), Vue, Svelte, Angular, Solid
81
+
82
+ | Priority | Glob Pattern | What to Extract |
83
+ |----------|-------------|-----------------|
84
+ | 1 | `**/pages/**`, `**/views/**`, `**/routes*` | Page tree, routing structure |
85
+ | 2 | `**/store/**`, `**/context/**`, `**/state/**`, `**/*slice*` | State shape, data flow |
86
+ | 3 | `**/api/**`, `**/services/**`, `**/hooks/use*` | API integration, data fetching |
87
+ | 4 | `**/components/**` (skim top-level) | Component architecture, shared vs feature |
88
+ | 5 | `**/types/**`, `**/interfaces/**`, `**/*.d.ts` | Data contracts, shared types |
89
+ | 6 | `**/utils/**`, `**/helpers/**` | Shared utilities |
90
+ | 7 | `**/config/**`, `.env*` | Feature flags, API URLs, build config |
91
+
92
+ **Feature signals:**
93
+ - Auth context/store + login pages → Authentication doc
94
+ - Form components + validation → Forms doc
95
+ - Data tables with pagination → Data Display doc
96
+ - Charts/dashboards → Analytics doc
97
+ - Theming/i18n files → Theming / Internationalization doc
98
+ - File upload components → Media Management doc
99
+
100
+ ---
101
+
102
+ ### Full-Stack Framework
103
+
104
+ **Signals:** Next.js, Nuxt, SvelteKit, Remix, RedwoodJS, Blitz, Astro (SSR)
105
+
106
+ | Priority | Glob Pattern | What to Extract |
107
+ |----------|-------------|-----------------|
108
+ | 1 | `**/app/**/page.*`, `**/pages/**`, `**/routes/**` | UI pages AND API routes — the router is the architecture |
109
+ | 2 | `**/api/**`, `**/server/**`, `**/actions/**` | Server-side logic, server actions |
110
+ | 3 | `**/models/**`, `**/schema*`, `**/prisma/**`, `**/drizzle/**` | Data layer, ORM config |
111
+ | 4 | `**/middleware.*`, `**/middleware/**` | Request pipeline, auth, redirects |
112
+ | 5 | `**/components/**` (skim top-level) | Shared UI components |
113
+ | 6 | `**/lib/**`, `**/utils/**`, `**/services/**` | Shared server + client utilities |
114
+ | 7 | `**/config/**`, `.env*`, `next.config.*`, `nuxt.config.*` | Framework and environment config |
115
+
116
+ **Feature signals:**
117
+ - All Web API signals + all Frontend SPA signals
118
+ - Server actions / mutations → Data Mutation doc
119
+ - ISR/SSG configuration → Rendering Strategy doc
120
+ - Edge functions / middleware → Edge Computing doc
121
+
122
+ ---
123
+
124
+ ### CLI Tool
125
+
126
+ **Signals:** Commander, Yargs, Click, Typer, Cobra, Clap, oclif, Argparse
127
+
128
+ | Priority | Glob Pattern | What to Extract |
129
+ |----------|-------------|-----------------|
130
+ | 1 | `**/commands/**`, `**/cmd/**`, `**/cli.*` | Command tree, subcommands |
131
+ | 2 | Main entry (`bin/*`, `src/index.*`, `src/main.*`) | Argument parsing, top-level flow |
132
+ | 3 | `**/config*`, `**/*rc*`, `**/settings*` | Config file formats, defaults |
133
+ | 4 | `**/utils/**`, `**/lib/**`, `**/core/**` | Core logic behind commands |
134
+ | 5 | `**/output*`, `**/format*`, `**/display*` | Output formatting (JSON, table, etc.) |
135
+ | 6 | `**/templates/**`, `**/scaffolds/**` | Code generation templates |
136
+
137
+ **Feature signals:**
138
+ - Multiple subcommands → one doc per command group
139
+ - Config file handling → Configuration doc
140
+ - Plugin/extension system → Plugin Architecture doc
141
+ - Interactive prompts → User Interaction doc
142
+ - File I/O operations → File Processing doc
143
+
144
+ ---
145
+
146
+ ### Library / SDK
147
+
148
+ **Signals:** Published package with `main`/`exports` in package.json, `lib/` with clear public API, type declarations
149
+
150
+ | Priority | Glob Pattern | What to Extract |
151
+ |----------|-------------|-----------------|
152
+ | 1 | Main export (`src/index.*`, `lib/index.*`, `__init__.py`) | Public API surface |
153
+ | 2 | `**/*.d.ts`, `**/types.*`, `**/interfaces.*` | Type contracts, input/output shapes |
154
+ | 3 | `**/core/**`, `**/lib/**` | Internal implementation |
155
+ | 4 | `**/utils/**`, `**/helpers/**` | Supporting utilities |
156
+ | 5 | `**/examples/**`, `**/demo/**` | Usage patterns |
157
+ | 6 | `**/plugins/**`, `**/adapters/**`, `**/providers/**` | Extension points |
158
+ | 7 | `**/tests/**` (skim 2-3) | Edge cases, expected behavior |
159
+
160
+ **Feature signals:**
161
+ - Multiple exported classes/functions → Core API doc
162
+ - Plugin/adapter pattern → Extension Architecture doc
163
+ - Multiple output formats → Serialization doc
164
+ - Caching layer → Performance doc
165
+
166
+ ---
167
+
168
+ ### Mobile App
169
+
170
+ **Signals:** React Native, Flutter, SwiftUI, Jetpack Compose, Expo, Ionic, Capacitor
171
+
172
+ | Priority | Glob Pattern | What to Extract |
173
+ |----------|-------------|-----------------|
174
+ | 1 | `**/screens/**`, `**/pages/**`, `**/views/**` | Screen tree, navigation structure |
175
+ | 2 | `**/navigation/**`, `**/router*` | Navigation graph, deep linking |
176
+ | 3 | `**/store/**`, `**/state/**`, `**/providers/**` | State management, data flow |
177
+ | 4 | `**/api/**`, `**/services/**`, `**/network/**` | Backend communication, offline sync |
178
+ | 5 | `**/components/**` (skim) | Shared UI components |
179
+ | 6 | `**/native/**`, `**/platform/**`, `**/ios/**`, `**/android/**` | Platform-specific code, native modules |
180
+ | 7 | `**/assets/**` (list only) | Bundled resources |
181
+
182
+ **Feature signals:**
183
+ - Push notification setup → Notifications doc
184
+ - Camera/media access → Media Capture doc
185
+ - Offline storage (SQLite, Realm, AsyncStorage) → Data Persistence doc
186
+ - Deep linking / universal links → Navigation doc
187
+ - Platform-specific native modules → Platform Integration doc
188
+
189
+ ---
190
+
191
+ ### Data Pipeline / ML
192
+
193
+ **Signals:** Airflow, dbt, Prefect, Dagster, Luigi, Pandas, Spark, TensorFlow, PyTorch, scikit-learn, Jupyter notebooks
194
+
195
+ | Priority | Glob Pattern | What to Extract |
196
+ |----------|-------------|-----------------|
197
+ | 1 | `**/dags/**`, `**/pipelines/**`, `**/flows/**`, `**/workflows/**` | Pipeline definitions, DAGs, task graph |
198
+ | 2 | `**/models/**` (ML or dbt) | Model definitions, training logic or SQL transforms |
199
+ | 3 | `**/sources/**`, `**/extractors/**`, `**/connectors/**` | Data sources, ingestion logic |
200
+ | 4 | `**/transforms/**`, `**/processors/**` | Data transformation logic |
201
+ | 5 | `**/schemas/**`, `**/contracts/**` | Data contracts, validation |
202
+ | 6 | `**/notebooks/**`, `*.ipynb` | Exploratory analysis, experiments |
203
+ | 7 | `**/config/**`, `**/profiles*` | Connection strings, environment config |
204
+
205
+ **Feature signals:**
206
+ - Multiple DAGs/pipelines → one doc per pipeline
207
+ - ML model training → Model Training doc
208
+ - Feature engineering → Feature Store doc
209
+ - Data validation (Great Expectations, Pandera) → Data Quality doc
210
+ - Scheduled runs → Orchestration doc
211
+
212
+ ---
213
+
214
+ ### Monorepo
215
+
216
+ **Signals:** Turborepo, Nx, Lerna, Rush, Bazel, pnpm workspaces — has `packages/`, `apps/`, or `workspace` config
217
+
218
+ | Priority | Glob Pattern | What to Extract |
219
+ |----------|-------------|-----------------|
220
+ | 1 | Root config (`turbo.json`, `nx.json`, `lerna.json`, `pnpm-workspace.yaml`) | Workspace structure, build pipeline |
221
+ | 2 | `packages/*/package.json` or `apps/*/package.json` | All packages/apps and their dependencies |
222
+ | 3 | `**/shared/**`, `**/common/**`, `**/core/**` | Shared packages that others depend on |
223
+ | 4 | Each app/package entry point (skim) | Purpose of each workspace member |
224
+
225
+ **Then apply the matching sub-archetype playbook** to each significant package/app (e.g., Web API for the backend, Frontend SPA for the frontend, Library for shared packages).
226
+
227
+ **Feature signals:**
228
+ - Shared packages → Shared Infrastructure doc
229
+ - Build/deploy pipeline → Build System doc
230
+ - Inter-package dependencies → Architecture Overview doc (dependency graph)
231
+
232
+ ---
233
+
234
+ ### Microservices
235
+
236
+ **Signals:** Docker Compose, Kubernetes manifests, multiple services with separate entry points, API gateway, service mesh
237
+
238
+ | Priority | Glob Pattern | What to Extract |
239
+ |----------|-------------|-----------------|
240
+ | 1 | `docker-compose*`, `**/k8s/**`, `**/helm/**`, `**/terraform/**` | Service topology, infrastructure |
241
+ | 2 | API gateway config, `**/gateway/**` | Routing, load balancing, auth gateway |
242
+ | 3 | Each service's entry point and routes (skim) | Service responsibilities, API surface |
243
+ | 4 | `**/proto/**`, `**/graphql/**`, `**/schemas/**` | Inter-service contracts (gRPC, GraphQL) |
244
+ | 5 | `**/queues/**`, `**/events/**`, `**/messaging/**` | Async communication, event bus |
245
+ | 6 | `**/shared/**`, `**/common/**` | Shared libraries across services |
246
+
247
+ **Then apply the Web API playbook** to each significant service.
248
+
249
+ **Feature signals:**
250
+ - Service discovery → Service Mesh doc
251
+ - Event-driven communication → Event Architecture doc
252
+ - Shared vs per-service database → Data Architecture doc
253
+ - Health checks / circuit breakers → Resilience doc
254
+
255
+ ---
256
+
257
+ ### Infrastructure / IaC
258
+
259
+ **Signals:** Terraform, Pulumi, CloudFormation, Ansible, CDK, Serverless Framework
260
+
261
+ | Priority | Glob Pattern | What to Extract |
262
+ |----------|-------------|-----------------|
263
+ | 1 | `**/main.tf`, `**/stacks/**`, `**/lib/**` (CDK) | Resource definitions, stack structure |
264
+ | 2 | `**/variables*`, `**/inputs*`, `**/config*` | Parameterization, environment configs |
265
+ | 3 | `**/modules/**`, `**/constructs/**` | Reusable infrastructure modules |
266
+ | 4 | `**/environments/**`, `**/stages/**` | Environment-specific overrides |
267
+ | 5 | `**/outputs*`, `**/exports*` | Cross-stack references |
268
+ | 6 | CI/CD config (`.github/workflows/`, `Jenkinsfile`) | Deployment pipeline |
269
+
270
+ **Feature signals:**
271
+ - Networking (VPC, subnets, security groups) → Networking doc
272
+ - Compute (ECS, Lambda, EC2) → Compute Architecture doc
273
+ - Data stores (RDS, DynamoDB, S3) → Data Infrastructure doc
274
+ - CI/CD pipeline → Deployment Pipeline doc
275
+ - Monitoring (CloudWatch, Datadog) → Observability doc
276
+
277
+ ---
278
+
279
+ ## Fallback — Unknown Archetype
280
+
281
+ If the project doesn't clearly match any archetype:
282
+
283
+ 1. List the root directory and `src/` (or equivalent)
284
+ 2. Read the top 5 largest files by line count
285
+ 3. Read any files with "main", "app", "server", "index", or "core" in the name
286
+ 4. Check test files — they reveal what developers think is important
287
+ 5. Check CI/CD config (`.github/workflows/`, `Jenkinsfile`) — pipeline steps reveal build/deploy architecture
288
+
289
+ Then propose an archetype to the user: *"This looks like a [X] project. I'll explore it using the [X] playbook. Sound right?"*
@@ -0,0 +1,123 @@
1
+ # Init Workflow
2
+
3
+ ## Step 1 — Explore
4
+
5
+ Follow the two-phase exploration strategy in `references/exploration-strategies.md`:
6
+
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 (Web API, Frontend SPA, Full-stack, CLI, Library, Mobile, Data Pipeline, Monorepo, Microservices, or Infrastructure).
9
+
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.
12
+
13
+ If the project spans multiple archetypes (e.g., a monorepo with frontend + API), apply multiple playbooks. If no archetype matches, use the Fallback strategy and confirm with the user.
14
+
15
+ Do not skim. Understand how the system actually works before proposing docs.
16
+
17
+ **Important:** Use your built-in file-reading tools to explore. Do NOT create scanner scripts, shell scripts, or any tooling. vdoc is purely AI-driven — no scripts, no build steps, no infrastructure.
18
+
19
+ **Phase 3 — Write Exploration Log**
20
+ After exploring, write `vdocs/_exploration_log.md` documenting what you found:
21
+
22
+ ```markdown
23
+ # Exploration Log
24
+
25
+ ## Fingerprint
26
+ - **Language(s):** e.g., TypeScript, Python
27
+ - **Framework(s):** e.g., Next.js 14, FastAPI
28
+ - **Archetype(s):** e.g., Full-stack Framework
29
+ - **Scope:** e.g., ~85 files, medium
30
+
31
+ ## Files Read
32
+ | # | File | Why | What I Found |
33
+ |---|------|-----|--------------|
34
+ | 1 | package.json | Fingerprint | Next.js 14, Prisma, NextAuth |
35
+ | 2 | src/app/ (listing) | Page tree | 12 routes, 3 API routes |
36
+ | ... | ... | ... | ... |
37
+
38
+ ## Feature Signals Detected
39
+ | Signal | Source File(s) | Proposed Doc |
40
+ |--------|---------------|--------------|
41
+ | Auth middleware + login page | middleware.ts, app/login/page.tsx | AUTHENTICATION_DOC.md |
42
+ | Prisma schema with 8 models | prisma/schema.prisma | DATA_MODEL_DOC.md |
43
+ | ... | ... | ... |
44
+
45
+ ## Ambiguities / Open Questions
46
+ - Could not determine why Redis is in dependencies — no usage found. Ask user.
47
+ - Payments folder exists but appears incomplete / WIP.
48
+ ```
49
+
50
+ This log is your working memory. It feeds directly into Step 2 (Plan).
51
+
52
+ ## Step 2 — Plan
53
+
54
+ Create `vdocs/_DOCUMENTATION_PLAN.md` listing each proposed doc:
55
+
56
+ ```markdown
57
+ # Documentation Plan
58
+
59
+ ## Proposed Documents
60
+
61
+ 1. **PROJECT_OVERVIEW_DOC.md** — Tech stack, architecture, project structure, dev setup
62
+ 2. **AUTHENTICATION_DOC.md** — OAuth2 flow, JWT lifecycle, session management, RBAC
63
+ 3. **API_REFERENCE_DOC.md** — All endpoints, request/response shapes, error codes
64
+ ...
65
+
66
+ ## Notes
67
+ - Each doc covers one logical feature, not one file
68
+ - Docs should be useful for onboarding AND as AI context for planning changes
69
+ ```
70
+
71
+ Present the plan to the user. Actively suggest changes:
72
+ - "Should I merge X and Y into one doc?"
73
+ - "I found a websocket system — want that documented separately?"
74
+ - "Any internal/legacy systems I should skip?"
75
+
76
+ Wait for user approval before proceeding.
77
+
78
+ ## Step 3 — Generate
79
+
80
+ For each approved doc:
81
+
82
+ 1. Read ALL relevant source files for that feature — not just the main file, but helpers, types, middleware, tests
83
+ 2. Follow the template in [doc-template.md](./doc-template.md) exactly
84
+ 3. Write to `vdocs/FEATURE_NAME_DOC.md`
85
+
86
+ **Writing rules:**
87
+
88
+ - **Mermaid diagrams are mandatory** in "How It Works". Show the actual flow — request lifecycle, state transitions, data pipeline. If a flow has more than 7-9 nodes, split into multiple diagrams.
89
+ - **Data Model** must show real entities from the code, not generic placeholders. Use mermaid ER diagrams for relational data, tables for simpler models.
90
+ - **Constraints & Decisions** is the most valuable section. Dig into the code for non-obvious choices: "Uses polling instead of websockets because...", "Auth tokens expire in 15min because...". If you can't find the reason, state the constraint and mark it: `Reason: unknown — verify with team`.
91
+ - **Related Features** must reference other docs by filename and explain the coupling: "Changes to the JWT schema will require updates to API_REFERENCE_DOC.md (auth middleware affects all endpoints)."
92
+ - **Configuration** must list actual env vars/secrets from the code, not hypothetical ones.
93
+ - **Error Handling** — trace what happens when things fail. What does the user see? What gets logged? Is there retry logic?
94
+
95
+ ## Step 4 — Manifest
96
+
97
+ Create `vdocs/_manifest.json` using the schema in [manifest-schema.json](./manifest-schema.json).
98
+
99
+ The `description` field is critical — write it rich enough that you can route any user question to the right doc by matching against descriptions. Include specific technology names, patterns, and concepts.
100
+
101
+ Example:
102
+
103
+ ```json
104
+ {
105
+ "filepath": "AUTHENTICATION_DOC.md",
106
+ "title": "Authentication - OAuth2 & JWT",
107
+ "version": "1.0.0",
108
+ "description": "OAuth2 flow with Google/GitHub providers, JWT token lifecycle, session management via NextAuth.js, route protection middleware, and role-based access control.",
109
+ "tags": ["oauth2", "jwt", "session-management", "rbac"]
110
+ }
111
+ ```
112
+
113
+ ## Step 5 — Self-Review
114
+
115
+ Before finishing, verify:
116
+
117
+ - [ ] Every doc has at least one mermaid diagram in "How It Works"
118
+ - [ ] Every doc has at least 2 entries in "Constraints & Decisions"
119
+ - [ ] Every doc's "Key Files" lists real paths that exist in the codebase
120
+ - [ ] Every doc's "Configuration" lists actual env vars from the code
121
+ - [ ] Every doc's "Related Features" references other doc filenames
122
+ - [ ] Manifest `description` is detailed enough for semantic routing
123
+ - [ ] No doc is just a shallow restatement of file names — each explains WHY and HOW
@@ -0,0 +1,16 @@
1
+ {
2
+ "project": "<project-name>",
3
+ "vdoc_version": "3.0.0",
4
+ "created_at": "<ISO-8601>",
5
+ "last_updated": "<ISO-8601>",
6
+ "last_commit": "<short-sha>",
7
+ "documentation": [
8
+ {
9
+ "filepath": "FEATURE_NAME_DOC.md",
10
+ "title": "Human-Readable Feature Title",
11
+ "version": "1.0.0",
12
+ "description": "Rich semantic description with specific technology names, patterns, and concepts. Detailed enough that an AI can route any user question to this doc by matching against this field.",
13
+ "tags": ["keyword-1", "keyword-2"]
14
+ }
15
+ ]
16
+ }
@@ -4,171 +4,55 @@ applyTo: "vdocs/**"
4
4
 
5
5
  # vdoc — Documentation Generator
6
6
 
7
- You generate and maintain feature-centric documentation for codebases. You have three modes: **init**, **audit**, and **query**.
8
-
9
- All documentation lives in `vdocs/` at the project root. The manifest at `vdocs/_manifest.json` is the semantic index you read first.
10
-
11
- ---
12
-
13
- ## Mode 1: Init
14
-
15
- **Trigger:** User says "document this project" or similar.
16
-
17
- ### Step 1 — Explore
18
-
19
- Read the codebase thoroughly. Identify:
20
-
21
- - **Tech stack**: languages, frameworks, databases, ORMs
22
- - **Features**: authentication, API, payments, notifications, search, etc.
23
- - **Architecture**: monolith vs microservices, frontend/backend split, key patterns
24
- - **Integrations**: third-party services (Stripe, AWS, Redis, etc.)
25
- - **Entry points**: where requests come in, how they flow through the system
26
-
27
- Do not skim. Read key files — entry points, config, routes, schemas, middleware.
28
-
29
- ### Step 2 — Plan
30
-
31
- Create `vdocs/_DOCUMENTATION_PLAN.md` listing each proposed doc with a one-line description. Present to user. Suggest merges, additions, or removals. Wait for approval.
32
-
33
- ### Step 3 — Generate
34
-
35
- For each approved doc, read ALL relevant source files and generate using this template:
36
-
37
- ```markdown
38
- # {Feature Title}
39
-
40
- > {One-line description}
41
-
42
- ---
43
-
44
7
  ## Overview
45
- {What it does, why it exists, how it fits in the system.}
46
8
 
47
- ---
9
+ Documentation must be feature-centric, plan-approved, and grounded in source code. Never generate docs from assumptions.
48
10
 
49
- ## How It Works
50
- {Core logic and flow.}
51
- {Mermaid diagram(s) max 7-9 nodes per diagram, split if larger.}
11
+ ## When to Use
12
+ - User says `/vdoc`, "document this project", "audit docs", or asks about documentation
13
+ - Docs are stale, missing, or out of sync with code (documentation drift, undocumented features, coverage gaps)
14
+ - After significant feature work that changed codebase behavior
52
15
 
53
- ---
54
-
55
- ## Data Model
56
- {Entities this feature owns. Mermaid ER diagram or table.}
57
-
58
- ---
59
-
60
- ## Key Files
61
- | File | Purpose |
62
- |------|---------|
63
- | `src/path/file.ts` | What this file does |
16
+ ## When NOT to Use
17
+ - API reference docs (use JSDoc/TSDoc)
18
+ - README files or contribution guides
19
+ - Inline code comments
64
20
 
65
21
  ---
66
22
 
67
- ## Dependencies & Integrations
68
- {External services, internal features, packages this relies on.}
23
+ This project uses vdoc for feature-centric documentation. All docs live in `vdocs/` with a semantic manifest at `vdocs/_manifest.json`.
69
24
 
70
- ---
25
+ For detailed workflows, read the vdoc skill at `.github/skills/vdoc/SKILL.md`.
71
26
 
72
- ## Configuration
73
- | Variable | Purpose | Required |
74
- |----------|---------|----------|
75
- | `ENV_VAR` | What it controls | Yes/No |
27
+ ## Quick Reference
76
28
 
77
- ---
78
-
79
- ## Error Handling
80
- {Failure modes, what the user sees, retry logic. Mermaid diagram if non-trivial.}
81
-
82
- ---
83
-
84
- ## Constraints & Decisions
85
- {Why it's built this way. What you CANNOT change without breaking things.}
86
-
87
- ---
88
-
89
- ## Related Features
90
- {Cross-references to other docs by filename. Blast radius notes.}
91
-
92
- ---
93
-
94
- *Generated by vdoc v3.0.0 • Last updated: {timestamp}*
95
- ```
96
-
97
- **Writing rules:**
98
-
99
- - **Mermaid diagrams are mandatory** in "How It Works". Max 7-9 nodes — split larger flows.
100
- - **Data Model** must show real entities from the code, not placeholders.
101
- - **Constraints & Decisions** is the most valuable section. Dig for non-obvious choices. If unclear, write: `Reason: unknown — verify with team`.
102
- - **Related Features** must reference other doc filenames and explain coupling.
103
- - **Configuration** must list actual env vars from the code.
104
- - **Error Handling** — trace what happens when things fail.
105
-
106
- ### Step 4 — Manifest
107
-
108
- Create `vdocs/_manifest.json`:
109
-
110
- ```json
111
- {
112
- "project": "<project-name>",
113
- "vdoc_version": "3.0.0",
114
- "created_at": "<ISO-8601>",
115
- "last_updated": "<ISO-8601>",
116
- "last_commit": "<short-sha>",
117
- "documentation": [
118
- {
119
- "filepath": "FEATURE_NAME_DOC.md",
120
- "title": "Human-Readable Title",
121
- "version": "1.0.0",
122
- "description": "Rich semantic description with technology names, patterns, concepts. Detailed enough for AI to route questions to this doc.",
123
- "tags": ["keyword-tag"]
124
- }
125
- ]
126
- }
127
- ```
128
-
129
- ### Step 5 — Self-Review
130
-
131
- Verify: every doc has mermaid diagrams, at least 2 constraints, real file paths, actual env vars, cross-references. Manifest descriptions are detailed for semantic routing. No hallucinated content.
132
-
133
- ---
134
-
135
- ## Mode 2: Audit
136
-
137
- **Trigger:** User says "audit docs" or similar.
138
-
139
- 1. **Read manifest** — load `vdocs/_manifest.json`
140
- 2. **Detect stale** — `git diff` or `git log --name-only --since="<last_updated>"` to find changed source files. Cross-reference with each doc's "Key Files" section.
141
- 3. **Detect gaps** — scan codebase for significant source files not covered by any doc (new routes, services, models, config).
142
- 4. **Detect dead docs** — check each doc's "Key Files" against filesystem. Flag docs referencing deleted files.
143
- 5. **Check cross-refs** — verify "Related Features" links still exist and coupling is accurate.
144
- 6. **Report** — present stale, gaps, dead, cross-ref issues, and current docs. Wait for user direction.
145
- 7. **Patch** — update stale docs, generate new docs for gaps, flag dead docs, fix cross-refs. Update manifest.
146
-
147
- ---
148
-
149
- ## Mode 3: Query
150
-
151
- **Trigger:** User asks any question about the codebase or documentation.
152
-
153
- 1. Read `vdocs/_manifest.json`
154
- 2. Match question against `description` and `tags` fields
155
- 3. Read matching doc(s)
156
- 4. Answer from documented knowledge
157
- 5. If no match, suggest running an audit
158
-
159
- ---
29
+ - **Init**: Explore codebase → Plan docs → Generate → Build manifest → Self-review
30
+ - **Audit**: Read manifest → Detect stale/gaps/dead → Check cross-refs → Report → Patch
31
+ - **Query**: Read manifest → Match description/tags → Read doc → Answer
160
32
 
161
33
  ## Naming Convention
162
34
 
163
35
  Files: `FEATURE_NAME_DOC.md` — uppercase, feature-named, `_DOC` suffix.
164
36
 
165
- ---
166
-
167
37
  ## Rules
168
38
 
169
- 1. **Feature-centric, not file-centric.** One doc per logical feature, not per source file.
39
+ 1. **Feature-centric, not file-centric.** One doc per logical feature.
170
40
  2. **Mermaid over prose.** Diagram flows. Max 7-9 nodes per diagram.
171
41
  3. **Constraints are gold.** Always fill "Constraints & Decisions".
172
42
  4. **Rich manifest descriptions.** Pack with specific terms for semantic routing.
173
43
  5. **No hallucination.** Only document what exists in code.
174
44
  6. **Plan first, always.** Never generate without user-approved plan.
45
+
46
+ ## Common Mistakes
47
+ - **File-centric instead of feature-centric** — Don't create one doc per source file. Group by logical feature.
48
+ - **Documenting aspirations** — Only document what the code actually does today, not planned work.
49
+ - **Skipping the plan** — Generating without user approval leads to rework and coverage gaps.
50
+ - **Oversized diagrams** — Keep Mermaid to 7-9 nodes; split if larger.
51
+ - **Shallow constraints** — "Constraints & Decisions" is the most valuable section. Dig for non-obvious choices.
52
+
53
+ ## Red Flags — STOP
54
+ - Generating docs without an approved plan
55
+ - Documenting something you haven't verified in source code
56
+ - Creating one doc per file instead of per feature
57
+ - Skipping Mermaid diagrams in "How It Works"
58
+ - Writing manifest descriptions too vague for semantic routing
@@ -1,31 +1,21 @@
1
1
  ---
2
2
  agent: 'agent'
3
- description: 'Generate and maintain feature-centric product documentation'
3
+ description: 'Use when user says /vdoc, document this project, audit docs, or asks about existing project documentation'
4
4
  name: 'vdoc'
5
5
  argument-hint: '[init|audit]'
6
- tools: ['changes', 'codebase', 'githubRepo', 'problems']
6
+ tools: ['search/changes', 'search/codebase', 'web/githubRepo', 'read/problems']
7
7
  ---
8
8
 
9
9
  # vdoc — Documentation Generator
10
10
 
11
- Run documentation workflows for this project. Full instructions are in `.github/instructions/vdoc.instructions.md`.
11
+ Run documentation workflows for this project.
12
12
 
13
13
  **Mode: ${input:mode:init}**
14
14
 
15
15
  ## If mode is `init` (or no `vdocs/` folder exists):
16
16
 
17
- 1. **Explore** Read the codebase: tech stack, features, architecture, integrations, entry points. Use #tool:codebase to search broadly. Read actual files.
18
- 2. **Plan** — Create `vdocs/_DOCUMENTATION_PLAN.md` listing proposed docs. Present to user. Wait for approval.
19
- 3. **Generate** — For each doc, read ALL relevant source files. Write `vdocs/FEATURE_NAME_DOC.md` following the template in `.github/instructions/vdoc.instructions.md`.
20
- 4. **Manifest** — Create `vdocs/_manifest.json` with rich semantic descriptions.
21
- 5. **Verify** — Every doc has mermaid diagrams, real paths, 2+ constraints, cross-references.
17
+ Read and follow the workflow at `.github/skills/vdoc/references/init-workflow.md`. Use `.github/skills/vdoc/references/doc-template.md` as the doc template and `.github/skills/vdoc/references/manifest-schema.json` for the manifest format.
22
18
 
23
19
  ## If mode is `audit` (or `vdocs/` already exists):
24
20
 
25
- 1. Read `vdocs/_manifest.json`
26
- 2. **Stale** — Use #tool:changes to find modified source files. Cross-ref with each doc's "Key Files" section.
27
- 3. **Gaps** — Find undocumented features (new routes, services, models)
28
- 4. **Dead** — Docs referencing deleted files
29
- 5. **Cross-refs** — Verify Related Features links still valid
30
- 6. **Report** — Present findings, wait for user direction
31
- 7. **Patch** — Update stale docs, generate gaps, fix cross-refs, update manifest
21
+ Read and follow the workflow at `.github/skills/vdoc/references/audit-workflow.md`.