@sandrinio/vdoc 3.5.1 → 3.5.2

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/bin/vdoc.mjs CHANGED
@@ -15,6 +15,7 @@ const PLATFORMS = {
15
15
  files: [
16
16
  { src: 'claude/vdoc-init.md', dest: '.claude/skills/vdoc-init/SKILL.md' },
17
17
  { src: 'claude/vdoc-update.md', dest: '.claude/skills/vdoc-update/SKILL.md' },
18
+ { src: 'claude/vdoc-audit.md', dest: '.claude/skills/vdoc-audit/SKILL.md' },
18
19
  { src: 'claude/vdoc-create.md', dest: '.claude/skills/vdoc-create/SKILL.md' },
19
20
  { src: 'claude/references/exploration-strategies.md', dest: '.claude/skills/vdoc-init/references/exploration-strategies.md' },
20
21
  { src: 'claude/references/doc-template.md', dest: '.claude/skills/vdoc-config/references/doc-template.md' },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sandrinio/vdoc",
3
- "version": "3.5.1",
3
+ "version": "3.5.2",
4
4
  "description": "Documentation skills for AI coding agents",
5
5
  "type": "module",
6
6
  "bin": {
@@ -0,0 +1,80 @@
1
+ ---
2
+ name: vdoc-audit
3
+ description: "Audit existing vdocs for stale, missing, or dead documentation. Use when user says 'audit docs', 'check docs', or documentation may be out of sync with code."
4
+ ---
5
+
6
+ # vdoc audit — Documentation Audit
7
+
8
+ Detect stale, missing, and dead documentation. Report and patch. Do NOT create scripts, shell files, scanners, or any tooling — use your built-in tools (Read, Glob, Grep, Bash for git commands) for everything.
9
+
10
+ ---
11
+
12
+ ## Step 1 — Read Current State
13
+
14
+ Read `vdocs/_manifest.json`. Load the list of documented features and their metadata.
15
+
16
+ ## Step 2 — Detect Stale Docs
17
+
18
+ Run `git log --name-only --since="<last_updated>" --pretty=format:""` or use `git diff` to find all source files that changed since the last audit.
19
+
20
+ Cross-reference changed files against each doc's "Key Files" section to identify which docs are stale.
21
+
22
+ ## Step 3 — Detect Coverage Gaps
23
+
24
+ Scan the codebase for significant features not covered by any doc. Look for:
25
+ - New route files / API endpoints
26
+ - New service classes or modules
27
+ - New database models / schema changes
28
+ - New configuration or infrastructure files
29
+
30
+ If you find undocumented features, propose new docs.
31
+
32
+ ## Step 4 — Detect Dead Docs
33
+
34
+ Check each doc's "Key Files" section against the actual filesystem. If key files no longer exist, the doc may be dead. Flag it: "PAYMENT_PROCESSING_DOC.md references 3 files that no longer exist — remove or archive?"
35
+
36
+ ## Step 5 — Check Cross-References
37
+
38
+ Read each doc's "Related Features" section. Verify that:
39
+ - Referenced doc filenames still exist
40
+ - The described coupling is still accurate (skim the relevant code)
41
+
42
+ ## Step 6 — Report
43
+
44
+ Present a clear report:
45
+
46
+ ```
47
+ Audit Report:
48
+
49
+ STALE (source files changed):
50
+ - AUTHENTICATION_DOC.md — src/lib/auth.ts changed (added GitHub provider)
51
+ - API_REFERENCE_DOC.md — 2 new endpoints added
52
+
53
+ COVERAGE GAPS (undocumented features):
54
+ - src/services/notification.ts — no doc covers notifications
55
+
56
+ DEAD DOCS (source files removed):
57
+ - LEGACY_ADMIN_DOC.md — all 4 source files deleted
58
+
59
+ CROSS-REF ISSUES:
60
+ - AUTHENTICATION_DOC.md references BILLING_DOC.md which no longer exists
61
+
62
+ CURRENT (no changes needed):
63
+ - DATABASE_SCHEMA_DOC.md
64
+ - PROJECT_OVERVIEW_DOC.md
65
+
66
+ Proceed with fixes?
67
+ ```
68
+
69
+ **Wait for user direction**, then:
70
+ - Patch stale docs (re-read source files, update affected sections only)
71
+ - Generate new docs for coverage gaps (use `/vdoc-create` for each)
72
+ - Flag dead docs for user to confirm deletion
73
+ - Fix cross-reference issues
74
+ - Update manifest: bump versions, update `last_updated`, `last_commit`
75
+
76
+ ## Rules
77
+
78
+ 1. **No scripts.** Do NOT create shell scripts, scanners, or build tools. Use Read/Glob/Grep/Bash(git).
79
+ 2. **Report before patching.** Always present findings and wait for user direction.
80
+ 3. **No hallucination.** Only report what you verified in the code and filesystem.