@esthernandez/vibe-doc 0.2.2 → 0.3.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/.claude-plugin/plugin.json +8 -0
- package/commands/check.md +7 -0
- package/commands/generate.md +11 -0
- package/commands/scan.md +11 -0
- package/commands/status.md +7 -0
- package/dist/generator/docx-writer.d.ts.map +1 -1
- package/dist/generator/docx-writer.js +13 -1
- package/dist/generator/extractor.d.ts.map +1 -1
- package/dist/generator/extractor.js +91 -0
- package/dist/generator/markdown-writer.d.ts.map +1 -1
- package/dist/generator/markdown-writer.js +13 -1
- package/dist/templates/index.d.ts +13 -0
- package/dist/templates/index.d.ts.map +1 -1
- package/dist/templates/index.js +14 -7
- package/dist/templates/renderer.d.ts.map +1 -1
- package/dist/templates/renderer.js +3 -1
- package/package.json +4 -1
- package/skills/check/SKILL.md +302 -0
- package/skills/generate/SKILL.md +359 -0
- package/skills/guide/AGENT_GUIDE.md +318 -0
- package/skills/guide/SKILL.md +270 -0
- package/skills/guide/references/breadcrumb-heuristics.md +441 -0
- package/skills/guide/references/classification-taxonomy.md +391 -0
- package/skills/guide/references/documentation-matrix.md +297 -0
- package/skills/scan/SKILL.md +219 -0
|
@@ -0,0 +1,391 @@
|
|
|
1
|
+
# Classification Taxonomy
|
|
2
|
+
|
|
3
|
+
Reference for Vibe Doc agents. Defines the 8 primary categories and 5 deployment contexts.
|
|
4
|
+
|
|
5
|
+
**Used by:** Scan skill (classification step), Generate skill (doc type selection).
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Primary Categories (8)
|
|
10
|
+
|
|
11
|
+
### 1. Web Application
|
|
12
|
+
|
|
13
|
+
**Definition:** Browser-based application with a frontend (React, Vue, Angular, etc.) and typically a backend service.
|
|
14
|
+
|
|
15
|
+
**Signals:**
|
|
16
|
+
- HTML/CSS/JavaScript assets in source tree
|
|
17
|
+
- Framework files (package.json with react/vue/angular, frontend build config)
|
|
18
|
+
- User authentication and sessions
|
|
19
|
+
- Database or data persistence layer
|
|
20
|
+
- API endpoints for frontend consumption
|
|
21
|
+
|
|
22
|
+
**Examples:**
|
|
23
|
+
- SaaS dashboards
|
|
24
|
+
- Content platforms
|
|
25
|
+
- Collaborative tools
|
|
26
|
+
- Admin panels
|
|
27
|
+
|
|
28
|
+
**Documentation focus:**
|
|
29
|
+
- User flows and access patterns
|
|
30
|
+
- API contracts (frontend ↔ backend)
|
|
31
|
+
- Deployment architecture (CDN, load balancing, session management)
|
|
32
|
+
- Security boundaries (auth, CORS, CSP)
|
|
33
|
+
|
|
34
|
+
**Required doc types:**
|
|
35
|
+
- Architecture Decision Records (decisions about tech stack, backend structure)
|
|
36
|
+
- Runbook (deployment, rollback, scaling)
|
|
37
|
+
- Threat Model (auth flows, data exposure, client-side vulnerabilities)
|
|
38
|
+
- Test Plan (end-to-end scenarios, cross-browser)
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
### 2. API / Microservice
|
|
43
|
+
|
|
44
|
+
**Definition:** Standalone service that exposes a programmatic interface (REST, GraphQL, gRPC, etc.), typically consumed by other services or client applications.
|
|
45
|
+
|
|
46
|
+
**Signals:**
|
|
47
|
+
- Route/endpoint definitions in code
|
|
48
|
+
- API documentation files (OpenAPI/Swagger, GraphQL schema)
|
|
49
|
+
- Request/response serialization (JSON, Protocol Buffers)
|
|
50
|
+
- Service-to-service communication patterns
|
|
51
|
+
- No frontend assets
|
|
52
|
+
- Containerization (Dockerfile)
|
|
53
|
+
|
|
54
|
+
**Examples:**
|
|
55
|
+
- REST APIs
|
|
56
|
+
- GraphQL servers
|
|
57
|
+
- gRPC services
|
|
58
|
+
- Webhook handlers
|
|
59
|
+
- Internal microservices
|
|
60
|
+
|
|
61
|
+
**Documentation focus:**
|
|
62
|
+
- Interface contracts (input/output specs, error codes)
|
|
63
|
+
- Deployment topology (scaling, service discovery, networking)
|
|
64
|
+
- Integration with other services
|
|
65
|
+
- Monitoring and alerting
|
|
66
|
+
|
|
67
|
+
**Required doc types:**
|
|
68
|
+
- API Specification (contract, versioning, error handling)
|
|
69
|
+
- Architecture Decision Records (service boundaries, protocol choice)
|
|
70
|
+
- Runbook (deployment, scaling, health checks)
|
|
71
|
+
- Threat Model (authentication, input validation, service-to-service trust)
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
### 3. Data Pipeline
|
|
76
|
+
|
|
77
|
+
**Definition:** ETL/ELT system that ingests, transforms, and outputs data. Can be batch (scheduled jobs) or streaming (continuous processing).
|
|
78
|
+
|
|
79
|
+
**Signals:**
|
|
80
|
+
- Job definitions (Airflow DAGs, Spark jobs, Cloud Functions with schedules)
|
|
81
|
+
- Data transformation code (pandas, dbt, SQL, Spark transformations)
|
|
82
|
+
- Scheduling configuration (cron, event triggers)
|
|
83
|
+
- Data source/sink configurations (databases, data lakes, message queues)
|
|
84
|
+
- Schema definitions or migrations
|
|
85
|
+
|
|
86
|
+
**Examples:**
|
|
87
|
+
- Analytics pipelines
|
|
88
|
+
- Data warehouses (ELT into Snowflake, BigQuery, Redshift)
|
|
89
|
+
- Real-time streaming (Kafka consumers, Dataflow)
|
|
90
|
+
- Report generation jobs
|
|
91
|
+
- ML training pipelines
|
|
92
|
+
|
|
93
|
+
**Documentation focus:**
|
|
94
|
+
- Data lineage and transformations
|
|
95
|
+
- SLAs and failure handling
|
|
96
|
+
- Data quality and validation
|
|
97
|
+
- Scheduling and dependencies
|
|
98
|
+
|
|
99
|
+
**Required doc types:**
|
|
100
|
+
- Data Model Documentation (schemas, transformations, lineage)
|
|
101
|
+
- Architecture Decision Records (orchestration tool choice, scheduling strategy)
|
|
102
|
+
- Runbook (job execution, failure recovery, data backups)
|
|
103
|
+
- Threat Model (data access controls, encryption, retention)
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
### 4. Infrastructure / Platform
|
|
108
|
+
|
|
109
|
+
**Definition:** Systems software that manages compute, networking, storage, or development tooling. Typically consumed internally by other services.
|
|
110
|
+
|
|
111
|
+
**Signals:**
|
|
112
|
+
- Infrastructure-as-code (Terraform, CloudFormation, Helm, etc.)
|
|
113
|
+
- Container orchestration (Kubernetes manifests, Docker Compose)
|
|
114
|
+
- Monitoring and observability configurations (Prometheus, Datadog, etc.)
|
|
115
|
+
- CLI or library interfaces
|
|
116
|
+
- Configuration management (Ansible, Chef, Puppet, etc.)
|
|
117
|
+
|
|
118
|
+
**Examples:**
|
|
119
|
+
- Kubernetes operators
|
|
120
|
+
- Database management platforms
|
|
121
|
+
- Internal tooling platforms
|
|
122
|
+
- CI/CD systems
|
|
123
|
+
- Observability platforms
|
|
124
|
+
|
|
125
|
+
**Documentation focus:**
|
|
126
|
+
- Resource provisioning and management
|
|
127
|
+
- High availability and disaster recovery
|
|
128
|
+
- Capacity planning
|
|
129
|
+
- Troubleshooting procedures
|
|
130
|
+
|
|
131
|
+
**Required doc types:**
|
|
132
|
+
- Architecture Decision Records (technology choices, design patterns)
|
|
133
|
+
- Runbook (provisioning, troubleshooting, upgrades, disaster recovery)
|
|
134
|
+
- Threat Model (access controls, privilege escalation, audit logging)
|
|
135
|
+
- Deployment Procedure (infrastructure deployment, blue-green, rolling updates)
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
### 5. Mobile Application
|
|
140
|
+
|
|
141
|
+
**Definition:** Native or cross-platform application running on mobile devices (iOS, Android).
|
|
142
|
+
|
|
143
|
+
**Signals:**
|
|
144
|
+
- Mobile framework files (Flutter, React Native, Swift, Kotlin, etc.)
|
|
145
|
+
- App store configuration (App.json, AndroidManifest.xml, etc.)
|
|
146
|
+
- Mobile-specific build processes
|
|
147
|
+
- Device permissions and capabilities usage
|
|
148
|
+
- Local data storage (SQLite, Realm, etc.)
|
|
149
|
+
|
|
150
|
+
**Examples:**
|
|
151
|
+
- Native iOS/Android apps
|
|
152
|
+
- Cross-platform apps (Flutter, React Native)
|
|
153
|
+
- Mobile-first web apps (PWAs)
|
|
154
|
+
|
|
155
|
+
**Documentation focus:**
|
|
156
|
+
- User onboarding and permissions flows
|
|
157
|
+
- Local vs. remote data synchronization
|
|
158
|
+
- Offline capabilities
|
|
159
|
+
- Platform-specific APIs (camera, location, etc.)
|
|
160
|
+
|
|
161
|
+
**Required doc types:**
|
|
162
|
+
- Architecture Decision Records (framework choice, offline strategy)
|
|
163
|
+
- Runbook (deployment to app stores, beta testing, hot patching)
|
|
164
|
+
- Threat Model (local data storage, network security, permissions)
|
|
165
|
+
- Test Plan (device compatibility, orientation, battery/memory constraints)
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
169
|
+
### 6. AI / ML System
|
|
170
|
+
|
|
171
|
+
**Definition:** Systems that train, serve, or continuously learn from data. Includes LLMs, recommendation engines, classifiers, etc.
|
|
172
|
+
|
|
173
|
+
**Signals:**
|
|
174
|
+
- Training code (TensorFlow, PyTorch, scikit-learn, etc.)
|
|
175
|
+
- Model files or checkpoints
|
|
176
|
+
- Feature engineering or preprocessing code
|
|
177
|
+
- Serving frameworks (TorchServe, TensorFlow Serving, HuggingFace, etc.)
|
|
178
|
+
- Experiment tracking (MLflow, Weights & Biases, etc.)
|
|
179
|
+
- Data versioning (DVC, Pachyderm, etc.)
|
|
180
|
+
|
|
181
|
+
**Examples:**
|
|
182
|
+
- LLM-powered applications
|
|
183
|
+
- Recommendation systems
|
|
184
|
+
- Computer vision systems
|
|
185
|
+
- NLP services
|
|
186
|
+
- Anomaly detection
|
|
187
|
+
|
|
188
|
+
**Documentation focus:**
|
|
189
|
+
- Model architecture and training process
|
|
190
|
+
- Data dependencies and quality requirements
|
|
191
|
+
- Performance metrics and SLOs
|
|
192
|
+
- Bias and fairness considerations
|
|
193
|
+
- Retraining frequency and triggers
|
|
194
|
+
|
|
195
|
+
**Required doc types:**
|
|
196
|
+
- Architecture Decision Records (framework, training strategy, serving approach)
|
|
197
|
+
- Data Model Documentation (features, data sources, versioning)
|
|
198
|
+
- Runbook (training procedures, model deployment, monitoring for drift)
|
|
199
|
+
- Threat Model (data poisoning, model extraction, adversarial inputs)
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
203
|
+
### 7. Integration / Connector
|
|
204
|
+
|
|
205
|
+
**Definition:** Glue code that connects external systems, APIs, or services together. Typically smaller, focused on data movement or event routing.
|
|
206
|
+
|
|
207
|
+
**Signals:**
|
|
208
|
+
- Third-party API client libraries
|
|
209
|
+
- Webhook handlers or event listeners
|
|
210
|
+
- Data transformation between system formats
|
|
211
|
+
- Minimal business logic (mostly mapping and routing)
|
|
212
|
+
- Scheduled sync jobs or event processors
|
|
213
|
+
|
|
214
|
+
**Examples:**
|
|
215
|
+
- Zapier-like automations
|
|
216
|
+
- Data sync connectors (Segment, Fivetran, etc.)
|
|
217
|
+
- Webhook bridges
|
|
218
|
+
- Payment processor integrations
|
|
219
|
+
- CRM sync tools
|
|
220
|
+
|
|
221
|
+
**Documentation focus:**
|
|
222
|
+
- External system contracts and APIs
|
|
223
|
+
- Error handling and retry logic
|
|
224
|
+
- Data transformations and mapping
|
|
225
|
+
- Authentication with external systems
|
|
226
|
+
|
|
227
|
+
**Required doc types:**
|
|
228
|
+
- API Specification (external system contracts being integrated)
|
|
229
|
+
- Architecture Decision Records (routing logic, error handling)
|
|
230
|
+
- Runbook (monitoring external service health, debugging sync failures)
|
|
231
|
+
- Threat Model (credential management, data in transit, third-party trust)
|
|
232
|
+
|
|
233
|
+
---
|
|
234
|
+
|
|
235
|
+
### 8. Claude Code Plugin
|
|
236
|
+
|
|
237
|
+
**Definition:** A Claude Code plugin or plugin marketplace — distributed to users rather than deployed to production infrastructure. Composed of skill files, slash command definitions, and an optional CLI. Runs inside a coding agent, not on a server.
|
|
238
|
+
|
|
239
|
+
**Signals:**
|
|
240
|
+
- `.claude-plugin/plugin.json` manifest (strongest signal — overrides any incidental web-framework signals)
|
|
241
|
+
- `.claude-plugin/marketplace.json` for multi-plugin repos
|
|
242
|
+
- `skills/<skill-name>/SKILL.md` files defining agent behaviors
|
|
243
|
+
- `commands/<command>.md` files defining slash commands
|
|
244
|
+
- A CLI entry point (`bin` field in `package.json`) distributed via npm, frequently scoped
|
|
245
|
+
- No runtime deployment target — the "deployment" is a user installing the plugin
|
|
246
|
+
|
|
247
|
+
**Examples:**
|
|
248
|
+
- `@esthernandez/app-project-readiness` — spec-driven development plugin
|
|
249
|
+
- `@esthernandez/vibe-doc` — documentation gap analyzer plugin
|
|
250
|
+
- Claude Code marketplace entries
|
|
251
|
+
|
|
252
|
+
**Documentation focus:**
|
|
253
|
+
- What the plugin does and who it's for (README)
|
|
254
|
+
- How a user installs it (install guide, multiple paths: npm, marketplace, local)
|
|
255
|
+
- What skills and slash commands it exposes (skill/command reference)
|
|
256
|
+
- How users can contribute or track changes (changelog + contributing)
|
|
257
|
+
|
|
258
|
+
**Required doc types:**
|
|
259
|
+
- README (what-it-is, install, quick example, license)
|
|
260
|
+
- Install Guide (prerequisites, install paths, verification, troubleshooting)
|
|
261
|
+
- Skill/Command Reference (per-skill + per-command reference with examples)
|
|
262
|
+
|
|
263
|
+
**Recommended doc types:**
|
|
264
|
+
- Architecture Decision Records (why the plugin is structured the way it is)
|
|
265
|
+
- Changelog + Contributing (Keep-a-Changelog + contributor onboarding)
|
|
266
|
+
- Test Plan (if the plugin has meaningful behavior to verify)
|
|
267
|
+
|
|
268
|
+
**Optional (not typically needed):**
|
|
269
|
+
- Runbook, API Specification, Deployment Procedure, Threat Model, Data Model — these are for systems with runtime/deployment/data concerns. Elevate to Recommended or Required only if the plugin reads/writes local files, stores user data, or has a non-trivial security surface (e.g., memory persistence, network calls to external services).
|
|
270
|
+
|
|
271
|
+
**Notes:**
|
|
272
|
+
- Plugins bundle neither a server nor a database, so traditional ops docs don't apply.
|
|
273
|
+
- The Skill/Command Reference is the plugin equivalent of an API spec — it's how users understand the interface they're consuming.
|
|
274
|
+
- If a plugin persists data (e.g., a user profile at `~/.claude/profiles/builder.json`), the Threat Model becomes Recommended: document what's stored, where, and how users can inspect/delete it.
|
|
275
|
+
|
|
276
|
+
---
|
|
277
|
+
|
|
278
|
+
## Deployment Contexts (5)
|
|
279
|
+
|
|
280
|
+
Modifiers that adjust Required/Recommended tiers for doc types.
|
|
281
|
+
|
|
282
|
+
### 1. Regulated
|
|
283
|
+
|
|
284
|
+
**Definition:** Subject to external compliance frameworks (legal, financial, healthcare, security standards).
|
|
285
|
+
|
|
286
|
+
**Frameworks include:**
|
|
287
|
+
- HIPAA (healthcare data)
|
|
288
|
+
- PCI-DSS (payment card data)
|
|
289
|
+
- SOC 2 (security and availability)
|
|
290
|
+
- GDPR (EU data privacy)
|
|
291
|
+
- FedRAMP (US government)
|
|
292
|
+
- NIST Cybersecurity Framework
|
|
293
|
+
- ISO 27001 (information security)
|
|
294
|
+
|
|
295
|
+
**Impact:** Elevates all security and operational docs to Required. Threat Model becomes critical. Audit logging and data residency must be documented.
|
|
296
|
+
|
|
297
|
+
**Required doc additions:**
|
|
298
|
+
- Threat Model (mandatory if not already Required)
|
|
299
|
+
- Deployment Procedure (must document compliance controls)
|
|
300
|
+
- Data Model Documentation (must include retention and residency)
|
|
301
|
+
|
|
302
|
+
---
|
|
303
|
+
|
|
304
|
+
### 2. Customer-Facing
|
|
305
|
+
|
|
306
|
+
**Definition:** Used directly by external customers (not internal-only).
|
|
307
|
+
|
|
308
|
+
**Characteristics:**
|
|
309
|
+
- User authentication and session management
|
|
310
|
+
- User-visible SLAs and uptime requirements
|
|
311
|
+
- Customer support procedures
|
|
312
|
+
- Data isolation between customers (if multi-tenant)
|
|
313
|
+
|
|
314
|
+
**Impact:** Elevates Runbook and Test Plan to Required. API Specification becomes critical if consumed by customer integrations.
|
|
315
|
+
|
|
316
|
+
**Required doc additions:**
|
|
317
|
+
- Runbook (must include SLA targets, escalation procedures)
|
|
318
|
+
- Test Plan (customer-impacting scenarios, regression testing)
|
|
319
|
+
- API Specification (if customers call APIs)
|
|
320
|
+
|
|
321
|
+
---
|
|
322
|
+
|
|
323
|
+
### 3. Internal Tooling
|
|
324
|
+
|
|
325
|
+
**Definition:** Used only by the organization's own team (employees, contractors).
|
|
326
|
+
|
|
327
|
+
**Characteristics:**
|
|
328
|
+
- Typically higher tolerance for downtime
|
|
329
|
+
- Feature velocity prioritized over stability
|
|
330
|
+
- Internal security (network perimeter, employee vetting)
|
|
331
|
+
- Changes can be communicated via Slack/email
|
|
332
|
+
|
|
333
|
+
**Impact:** Lowers recommended docs to optional. Threat Model less critical (internal attack surface smaller). Runbook can focus on rapid recovery.
|
|
334
|
+
|
|
335
|
+
**Effect:**
|
|
336
|
+
- Optional docs may stay optional (Changelog, Contributing Guide)
|
|
337
|
+
- Runbook emphasizes quick fixes over prevention
|
|
338
|
+
|
|
339
|
+
---
|
|
340
|
+
|
|
341
|
+
### 4. Multi-Tenant
|
|
342
|
+
|
|
343
|
+
**Definition:** Single deployment serves multiple customers/organizations with data isolation.
|
|
344
|
+
|
|
345
|
+
**Characteristics:**
|
|
346
|
+
- Tenant isolation strategies (row-level security, schema per tenant, etc.)
|
|
347
|
+
- Resource quotas and fair usage limits
|
|
348
|
+
- Billing and metering logic
|
|
349
|
+
- Account management and provisioning
|
|
350
|
+
|
|
351
|
+
**Impact:** Adds Data Model Documentation to Required. Threat Model must include tenant isolation analysis.
|
|
352
|
+
|
|
353
|
+
**Required doc additions:**
|
|
354
|
+
- Data Model Documentation (isolation strategy, schema design)
|
|
355
|
+
- Threat Model (tenant escape scenarios, data leakage)
|
|
356
|
+
- API Specification (tenant context, authorization scopes)
|
|
357
|
+
|
|
358
|
+
---
|
|
359
|
+
|
|
360
|
+
### 5. Edge / Embedded
|
|
361
|
+
|
|
362
|
+
**Definition:** Runs on edge devices, embedded systems, or has severe resource constraints (CPU, memory, network).
|
|
363
|
+
|
|
364
|
+
**Characteristics:**
|
|
365
|
+
- Device-specific constraints (ARM architecture, low memory, intermittent connectivity)
|
|
366
|
+
- Firmware or binary deployments
|
|
367
|
+
- Over-the-air (OTA) update mechanisms
|
|
368
|
+
- Offline-first design
|
|
369
|
+
|
|
370
|
+
**Impact:** Elevates Deployment Procedure and Runbook to Required. Test Plan must cover resource-constrained scenarios.
|
|
371
|
+
|
|
372
|
+
**Required doc additions:**
|
|
373
|
+
- Deployment Procedure (OTA process, version management, rollback on devices)
|
|
374
|
+
- Runbook (recovery from resource exhaustion, network disconnects)
|
|
375
|
+
- Test Plan (performance under constraints, battery/memory profiling)
|
|
376
|
+
|
|
377
|
+
---
|
|
378
|
+
|
|
379
|
+
## Classification Resolution
|
|
380
|
+
|
|
381
|
+
When artifacts show mixed signals, resolve by asking:
|
|
382
|
+
|
|
383
|
+
1. **What is the primary deployment target?** (Web, API, data system, etc.)
|
|
384
|
+
2. **Who are the primary users?** (Customers, internal, public, etc.)
|
|
385
|
+
3. **What's the biggest operational risk?** (Uptime, data loss, security breach, etc.)
|
|
386
|
+
|
|
387
|
+
The answer to question 1 determines primary category. Questions 2-3 determine deployment contexts.
|
|
388
|
+
|
|
389
|
+
---
|
|
390
|
+
|
|
391
|
+
**Last updated:** 2026-04-15 | **Reference version:** 1.1
|
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
# Documentation Matrix
|
|
2
|
+
|
|
3
|
+
Reference for agents. Maps (Primary Category × Deployment Context) to doc type tiers (Required/Recommended/Optional).
|
|
4
|
+
|
|
5
|
+
**Used by:** Scan skill (to determine gaps), Generate skill (to select doc types).
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Ops-Focused Matrix (8×7)
|
|
10
|
+
|
|
11
|
+
Primary Categories × the original 7 operational document types. Base tier before deployment context modifiers.
|
|
12
|
+
|
|
13
|
+
| Category | Threat Model | ADRs | Runbook | API Spec | Deployment Proc | Test Plan | Data Model |
|
|
14
|
+
| --------------------------- | ------------ | ----------- | ----------- | ----------- | --------------- | ----------- | ----------- |
|
|
15
|
+
| **Web App** | Recommended | Recommended | Required | Required | Required | Recommended | Required |
|
|
16
|
+
| **API/Microservice** | Required | Recommended | Required | Required | Required | Recommended | Recommended |
|
|
17
|
+
| **Data Pipeline** | Recommended | Recommended | Required | Optional | Required | Required | Required |
|
|
18
|
+
| **Infrastructure/Platform** | Recommended | Recommended | Required | Optional | Required | Recommended | Optional |
|
|
19
|
+
| **Mobile App** | Required | Recommended | Required | Recommended | Required | Required | Recommended |
|
|
20
|
+
| **AI/ML System** | Required | Recommended | Required | Recommended | Required | Required | Required |
|
|
21
|
+
| **Integration/Connector** | Recommended | Recommended | Recommended | Required | Recommended | Recommended | Optional |
|
|
22
|
+
| **Claude Code Plugin** | Optional | Recommended | Optional | Optional | Optional | Recommended | Optional |
|
|
23
|
+
|
|
24
|
+
*Note: Table values above reflect the `BASE_MATRIX` in `packages/vibe-doc/src/gap-analyzer/matrix.ts` — source of truth is the code, this table is the human-readable mirror.*
|
|
25
|
+
|
|
26
|
+
## Plugin-Focused Matrix (8×4)
|
|
27
|
+
|
|
28
|
+
The same 8 categories × 4 plugin-oriented document types introduced in v0.2.2. These cover the "what-is-this-tool and how-do-I-use-it" docs that matter for distributed plugins and CLIs.
|
|
29
|
+
|
|
30
|
+
| Category | README | Install Guide | Skill/Command Ref | Changelog/Contributing |
|
|
31
|
+
| --------------------------- | ----------- | ------------- | ----------------- | ---------------------- |
|
|
32
|
+
| **Web App** | Required | Recommended | Optional | Recommended |
|
|
33
|
+
| **API/Microservice** | Required | Recommended | Optional | Recommended |
|
|
34
|
+
| **Data Pipeline** | Required | Recommended | Optional | Recommended |
|
|
35
|
+
| **Infrastructure/Platform** | Required | Required | Optional | Recommended |
|
|
36
|
+
| **Mobile App** | Required | Required | Optional | Recommended |
|
|
37
|
+
| **AI/ML System** | Required | Recommended | Optional | Recommended |
|
|
38
|
+
| **Integration/Connector** | Required | Required | Recommended | Recommended |
|
|
39
|
+
| **Claude Code Plugin** | Required | Required | Required | Recommended |
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Deployment Context Modifiers
|
|
44
|
+
|
|
45
|
+
### Regulated (HIPAA, PCI-DSS, SOC 2, GDPR, FedRAMP, NIST, ISO 27001)
|
|
46
|
+
|
|
47
|
+
**Effect:** Elevates all docs one tier (Required → stays Required; Recommended → Required; Optional → Recommended).
|
|
48
|
+
|
|
49
|
+
**Special additions:**
|
|
50
|
+
- Threat Model becomes Required (if not already)
|
|
51
|
+
- Deployment Procedure must document compliance controls
|
|
52
|
+
- Data Model must include retention and data residency
|
|
53
|
+
|
|
54
|
+
**Examples:**
|
|
55
|
+
- Web App + Regulated: Threat Model (R), ADRs (R), Runbook (R), API Spec (R), Deployment Proc (R), Test Plan (Rec), Data Model (Rec)
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
### Customer-Facing
|
|
60
|
+
|
|
61
|
+
**Effect:** Elevates User-visible docs (Runbook, Test Plan, API Spec if customers integrate).
|
|
62
|
+
|
|
63
|
+
**Special additions:**
|
|
64
|
+
- Runbook becomes Required (SLAs, escalation must be documented)
|
|
65
|
+
- Test Plan becomes Required (customer regression testing essential)
|
|
66
|
+
- API Specification becomes Required (if customers call APIs)
|
|
67
|
+
|
|
68
|
+
**Examples:**
|
|
69
|
+
- Web App + Customer-Facing: Threat Model (R), ADRs (R), Runbook (R), API Spec (Rec→R if exposed), Deployment Proc (Rec), Test Plan (Rec→R), Data Model (Rec)
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
### Internal Tooling
|
|
74
|
+
|
|
75
|
+
**Effect:** Lowers non-critical docs. Runbook can focus on rapid recovery vs. prevention.
|
|
76
|
+
|
|
77
|
+
**Special additions:**
|
|
78
|
+
- Optional docs may stay optional (lower urgency on Changelog, Contributing)
|
|
79
|
+
- Threat Model may downgrade to Recommended (internal attack surface smaller)
|
|
80
|
+
|
|
81
|
+
**Examples:**
|
|
82
|
+
- Data Pipeline + Internal: Threat Model (Rec), ADRs (R), Runbook (R), API Spec (Opt), Deployment Proc (Rec), Test Plan (Rec), Data Model (R)
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
### Multi-Tenant
|
|
87
|
+
|
|
88
|
+
**Effect:** Makes Data Model and API Spec Required (isolation strategy must be clear).
|
|
89
|
+
|
|
90
|
+
**Special additions:**
|
|
91
|
+
- Data Model Documentation becomes Required
|
|
92
|
+
- API Specification becomes Required (tenant context, authorization scopes)
|
|
93
|
+
- Threat Model must include tenant isolation analysis
|
|
94
|
+
|
|
95
|
+
**Examples:**
|
|
96
|
+
- Web App + Multi-Tenant: Threat Model (R), ADRs (R), Runbook (R), API Spec (Rec→R), Deployment Proc (Rec), Test Plan (Rec), Data Model (Rec→R)
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
### Edge / Embedded
|
|
101
|
+
|
|
102
|
+
**Effect:** Elevates deployment and testing docs.
|
|
103
|
+
|
|
104
|
+
**Special additions:**
|
|
105
|
+
- Deployment Procedure becomes Required (OTA, version mgmt, device rollback)
|
|
106
|
+
- Runbook becomes Required (resource exhaustion, connectivity issues)
|
|
107
|
+
- Test Plan becomes Required (performance under constraints)
|
|
108
|
+
|
|
109
|
+
**Examples:**
|
|
110
|
+
- Mobile App + Edge: Threat Model (Rec), ADRs (R), Runbook (Rec→R), API Spec (Rec), Deployment Proc (Rec→R), Test Plan (Rec→R), Data Model (Rec)
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## Applied Examples
|
|
115
|
+
|
|
116
|
+
### Example 1: Web App + Regulated (HIPAA) + Customer-Facing
|
|
117
|
+
|
|
118
|
+
**Base (Web App):**
|
|
119
|
+
- Threat Model: Required
|
|
120
|
+
- ADRs: Required
|
|
121
|
+
- Runbook: Required
|
|
122
|
+
- API Spec: Recommended
|
|
123
|
+
- Deployment Proc: Recommended
|
|
124
|
+
- Test Plan: Recommended
|
|
125
|
+
- Data Model: Recommended
|
|
126
|
+
|
|
127
|
+
**Apply Regulated modifier:**
|
|
128
|
+
- Everything Recommended → Required
|
|
129
|
+
- Threat Model (stays Required)
|
|
130
|
+
- Result: Threat Model (R), ADRs (R), Runbook (R), API Spec (R), Deployment Proc (R), Test Plan (R), Data Model (R)
|
|
131
|
+
|
|
132
|
+
**Apply Customer-Facing modifier:**
|
|
133
|
+
- Runbook (stays Required)
|
|
134
|
+
- Test Plan (stays Required)
|
|
135
|
+
- API Spec (stays Required)
|
|
136
|
+
- Result: All 7 docs are Required
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
### Example 2: Data Pipeline + Internal Tooling
|
|
141
|
+
|
|
142
|
+
**Base (Data Pipeline):**
|
|
143
|
+
- Threat Model: Recommended
|
|
144
|
+
- ADRs: Required
|
|
145
|
+
- Runbook: Required
|
|
146
|
+
- API Spec: Optional
|
|
147
|
+
- Deployment Proc: Recommended
|
|
148
|
+
- Test Plan: Recommended
|
|
149
|
+
- Data Model: Required
|
|
150
|
+
|
|
151
|
+
**Apply Internal Tooling modifier:**
|
|
152
|
+
- Threat Model: Recommended (downgrades to Optional for truly internal)
|
|
153
|
+
- Rest stay the same
|
|
154
|
+
- Result: Threat Model (Opt), ADRs (R), Runbook (R), API Spec (Opt), Deployment Proc (Rec), Test Plan (Rec), Data Model (R)
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
### Example 3: API/Microservice + Multi-Tenant
|
|
159
|
+
|
|
160
|
+
**Base (API/Microservice):**
|
|
161
|
+
- Threat Model: Required
|
|
162
|
+
- ADRs: Required
|
|
163
|
+
- Runbook: Required
|
|
164
|
+
- API Spec: Required
|
|
165
|
+
- Deployment Proc: Recommended
|
|
166
|
+
- Test Plan: Recommended
|
|
167
|
+
- Data Model: Recommended
|
|
168
|
+
|
|
169
|
+
**Apply Multi-Tenant modifier:**
|
|
170
|
+
- Data Model: Recommended → Required
|
|
171
|
+
- API Spec: Required (stays required, now must include tenant context)
|
|
172
|
+
- Threat Model: Required (must include isolation analysis)
|
|
173
|
+
- Result: Threat Model (R), ADRs (R), Runbook (R), API Spec (R), Deployment Proc (Rec), Test Plan (Rec), Data Model (R)
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
### Example 4: Mobile App + Edge + Customer-Facing
|
|
178
|
+
|
|
179
|
+
**Base (Mobile App):**
|
|
180
|
+
- Threat Model: Recommended
|
|
181
|
+
- ADRs: Required
|
|
182
|
+
- Runbook: Recommended
|
|
183
|
+
- API Spec: Recommended
|
|
184
|
+
- Deployment Proc: Required
|
|
185
|
+
- Test Plan: Required
|
|
186
|
+
- Data Model: Recommended
|
|
187
|
+
|
|
188
|
+
**Apply Edge modifier:**
|
|
189
|
+
- Deployment Proc: Required (stays required, OTA focus)
|
|
190
|
+
- Runbook: Recommended → Required (device recovery, offline handling)
|
|
191
|
+
- Test Plan: Required (stays required, add resource constraints)
|
|
192
|
+
|
|
193
|
+
**Apply Customer-Facing modifier:**
|
|
194
|
+
- Runbook: Required (stays required)
|
|
195
|
+
- Test Plan: Required (stays required)
|
|
196
|
+
- API Spec: Recommended → Required (if customers integrate)
|
|
197
|
+
|
|
198
|
+
**Final:** Threat Model (Rec), ADRs (R), Runbook (R), API Spec (R), Deployment Proc (R), Test Plan (R), Data Model (Rec)
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
### Example 5: Claude Code Plugin (no modifiers)
|
|
203
|
+
|
|
204
|
+
**Base (Claude Code Plugin):**
|
|
205
|
+
- README: Required
|
|
206
|
+
- Install Guide: Required
|
|
207
|
+
- Skill/Command Reference: Required
|
|
208
|
+
- ADRs: Recommended
|
|
209
|
+
- Test Plan: Recommended
|
|
210
|
+
- Changelog/Contributing: Recommended
|
|
211
|
+
- Threat Model: Optional
|
|
212
|
+
- Runbook: Optional
|
|
213
|
+
- API Spec: Optional
|
|
214
|
+
- Deployment Proc: Optional
|
|
215
|
+
- Data Model: Optional
|
|
216
|
+
|
|
217
|
+
**Why this rubric:** Plugins are distributed to users, not deployed to runtime infrastructure. The traditional ops docs (runbook, deployment procedure, data model) don't apply unless the plugin persists data or has a meaningful runtime surface. Instead, what matters is "what does this plugin do, how do I install it, and what commands does it expose" — hence README, Install Guide, and Skill/Command Reference as the three Required docs.
|
|
218
|
+
|
|
219
|
+
**If the plugin persists user data** (e.g., `~/.claude/profiles/builder.json`), elevate Threat Model to Recommended and document what's stored, where, and how users can inspect or delete it.
|
|
220
|
+
|
|
221
|
+
**Final:** README (R), Install Guide (R), Skill/Command Reference (R), ADRs (Rec), Test Plan (Rec), Changelog/Contributing (Rec), everything else (Opt).
|
|
222
|
+
|
|
223
|
+
---
|
|
224
|
+
|
|
225
|
+
## Tier Definitions
|
|
226
|
+
|
|
227
|
+
### Required (Deployment Blocker)
|
|
228
|
+
|
|
229
|
+
Must exist and be current before production deployment. Missing or stale Required docs block the `vibe-doc check` command.
|
|
230
|
+
|
|
231
|
+
**Characteristics:**
|
|
232
|
+
- Essential for safe operations
|
|
233
|
+
- Directly impacts security, reliability, or compliance
|
|
234
|
+
- Must be reviewed before deployment decision
|
|
235
|
+
|
|
236
|
+
### Recommended (Should Do)
|
|
237
|
+
|
|
238
|
+
Should exist before production, but not a hard blocker. Helpful for operations, support, and future maintenance.
|
|
239
|
+
|
|
240
|
+
**Characteristics:**
|
|
241
|
+
- Valuable for ongoing operations
|
|
242
|
+
- Helps with debugging, scaling, and knowledge transfer
|
|
243
|
+
- Can be created shortly after deployment with a priority
|
|
244
|
+
|
|
245
|
+
### Optional (Nice to Have)
|
|
246
|
+
|
|
247
|
+
Lower priority. Good to have but not essential for initial deployment. Often created after the system is stable.
|
|
248
|
+
|
|
249
|
+
**Characteristics:**
|
|
250
|
+
- Community-focused (Contributing Guide)
|
|
251
|
+
- Long-term knowledge (Changelog, Benchmarks)
|
|
252
|
+
- Can be added in retrospect without risk
|
|
253
|
+
|
|
254
|
+
---
|
|
255
|
+
|
|
256
|
+
## How Agents Use This Matrix
|
|
257
|
+
|
|
258
|
+
**During Scan skill:**
|
|
259
|
+
1. Determine primary category (Web App, API, etc.)
|
|
260
|
+
2. Identify deployment contexts (Regulated? Customer-facing? Multi-tenant? Edge?)
|
|
261
|
+
3. Look up base tiers from matrix
|
|
262
|
+
4. Apply each deployment context modifier
|
|
263
|
+
5. Calculate final Required/Recommended/Optional lists
|
|
264
|
+
|
|
265
|
+
**During Generate skill:**
|
|
266
|
+
1. Show user which gaps are Required vs. Recommended
|
|
267
|
+
2. Suggest starting with Required tier
|
|
268
|
+
3. Let user pick specific gaps to generate
|
|
269
|
+
4. Pre-populate synthesis questions based on doc type
|
|
270
|
+
|
|
271
|
+
**During Check skill:**
|
|
272
|
+
1. Read classification from state
|
|
273
|
+
2. Look up Required docs for that classification
|
|
274
|
+
3. Check if Required docs exist and are current
|
|
275
|
+
4. Return pass/fail based on Required tier only (Recommended/Optional ignored)
|
|
276
|
+
|
|
277
|
+
---
|
|
278
|
+
|
|
279
|
+
## Tier Override Pattern
|
|
280
|
+
|
|
281
|
+
If user's situation doesn't match the matrix:
|
|
282
|
+
|
|
283
|
+
```
|
|
284
|
+
The matrix suggests Threat Model is Recommended for your stack.
|
|
285
|
+
But given that you're handling customer payment data, I'm elevating
|
|
286
|
+
it to Required.
|
|
287
|
+
|
|
288
|
+
Do you agree, or would you like to override?
|
|
289
|
+
[agree] → Threat Model is Required
|
|
290
|
+
[override] → Keep it as Recommended
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
Agents should respect user overrides. Document the override in state for future reference.
|
|
294
|
+
|
|
295
|
+
---
|
|
296
|
+
|
|
297
|
+
**Last updated:** 2026-04-15 | **Reference version:** 1.1
|