Skip to content

Commit 8e53ccc

Browse files
thephezclaude
andcommitted
docs(skills): tighten doc-audit SKILL.md schema and examples
Remove redundant confidence section, update skill_version to 2026-04-06, add branch/commit fields to audit_run schema, and slim down the example finding to reduce noise. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent a768bfa commit 8e53ccc

1 file changed

Lines changed: 17 additions & 58 deletions

File tree

.claude/skills/doc-audit/SKILL.md

Lines changed: 17 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -127,14 +127,6 @@ Before auditing a page, classify its primary purpose. Judge it against that purp
127127

128128
---
129129

130-
## Confidence
131-
132-
- high
133-
- medium
134-
- low
135-
136-
---
137-
138130
## Source-of-truth precedence
139131

140132
When sources disagree, prefer evidence in this order unless project-specific instructions say otherwise:
@@ -304,7 +296,7 @@ Create the directory under the project root. If a different output location is s
304296

305297
- `audit_id` — generate a short unique ID, e.g. `audit-2024-001`
306298
- `agent_version` — use `unknown` if not determinable
307-
- `skill_version``2025-03`
299+
- `skill_version``2026-04-06`
308300
- `generated_at` — ISO 8601 timestamp
309301

310302
---
@@ -384,8 +376,12 @@ audit_run:
384376
audit_id: string
385377
doc_site: string
386378
docs_repo: string
379+
docs_branch: string # branch audited
380+
docs_commit: string # HEAD commit hash at audit time
387381
code_repos:
388-
- string
382+
- repo: string
383+
branch: string # branch audited
384+
commit: string # HEAD commit hash at audit time
389385
audit_type: baseline | incremental | verification
390386
generated_at: string
391387
agent_version: string
@@ -443,53 +439,23 @@ findings:
443439
2. Audit remaining API reference pages for similar endpoint drift
444440
```
445441

446-
### Findings (YAML)
442+
### Example finding (YAML)
447443

448444
```yaml
449-
audit_run:
450-
audit_id: audit-2024-001
451-
doc_site: https://docs.example.com
452-
docs_repo: my-org/my-repo
453-
code_repos:
454-
- my-org/my-repo
455-
audit_type: baseline
456-
generated_at: "2024-11-01T14:00:00Z"
457-
agent_version: unknown
458-
skill_version: "2025-03"
459-
460-
scope:
461-
doc_paths:
462-
- docs/api/authentication.md
463-
code_paths:
464-
- src/auth/
465-
exclusions:
466-
- docs/changelog.md
467-
notes: null
468-
469-
summary:
470-
pages_reviewed: 1
471-
findings_total: 1
472-
by_severity:
473-
critical: 1
474-
high: 0
475-
medium: 0
476-
low: 0
477-
info: 0
478-
by_issue_type:
479-
outdated_api: 1
445+
# audit_run, scope, and summary follow the envelope schema above
480446

481447
findings:
482448
- finding_id: F-001
483-
title: Authentication endpoint documented as /v1/auth but code uses /v2/auth
449+
title: Auth endpoint /v1/auth should be /v2/auth
484450
severity: critical
485451
confidence: high
486452
issue_type: outdated_api
487453
doc_file: docs/api/authentication.md
488454
content_type: reference
489-
summary: The docs show the old /v1/auth endpoint which no longer exists.
490-
current_doc_behavior: Documents POST /v1/auth for token exchange.
491-
expected_behavior: Endpoint is POST /v2/auth as of v2.0.0.
492-
discrepancy: /v1/auth returns 404 in current code; /v2/auth is the correct path.
455+
summary: Docs reference removed /v1/auth endpoint
456+
current_doc_behavior: POST /v1/auth for token exchange
457+
expected_behavior: POST /v2/auth (since v2.0.0)
458+
discrepancy: Endpoint path differs (/v1/auth vs /v2/auth)
493459
evidence:
494460
doc_refs:
495461
- file: docs/api/authentication.md
@@ -498,23 +464,16 @@ findings:
498464
- repo: my-org/my-repo
499465
file: src/auth/routes.py
500466
lines: "12-18"
501-
impact: Developers following the docs will get 404s and cannot authenticate.
502-
recommended_update: Update endpoint to /v2/auth and note the v2.0.0 migration.
467+
impact: Readers get 404s on auth
468+
recommended_update: Update endpoint path to /v2/auth
503469
doc_locator:
504470
type: anchor
505471
value: "#endpoint"
506472
fallback_text_match: "POST /v1/auth"
507473
edit_type: replace
508474
edit_instructions:
509475
- target: "POST /v1/auth"
510-
action: Replace the endpoint path and update any surrounding prose that references v1.
476+
action: Replace endpoint path and update any references to v1
511477
new_text: "POST /v2/auth"
512-
# optional fields included for this example:
513-
tags: [auth, endpoint]
514-
update_group: auth-endpoint-migration
515-
fix_priority: immediate
516-
user_risk: breakage
517-
affected_code_paths:
518-
- src/auth/routes.py
519-
status: open
478+
# optional fields (tags, update_group, fix_priority, etc.) as needed
520479
```

0 commit comments

Comments
 (0)