documentation-audit
Verify Documentation Against Code
Documentation can drift after refactors, releases, and deleted files. This skill extracts claims, checks them against code, and produces an evidence-based audit report.
Stop for confirmation before installing.
Review the plan and obtain explicit user consent before changing files.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Review the Skillstore skill "documentation-audit" from https://skillstore.io/skills/2389-research-documentation-audit.md and its manifest at https://skillstore.io/api/skills/2389-research-documentation-audit/manifest. Verify the artifact. Stop and obtain explicit user consent before installing or changing files.Your Agent should still show its plan and request any confirmation required by the security policy.
Agent-readable resources
Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.
Test it
Using "documentation-audit". Audit README.md before a release.
Expected outcome:
The report identifies 42 claims, confirms 36, marks 4 false, and sends 2 behavior claims to human review.
Using "documentation-audit". Check docs after a configuration refactor.
Expected outcome:
Finds stale default values, unsupported environment variables, and missing script documentation with file and line evidence.
Using "documentation-audit". Compare documented services with actual service files.
Expected outcome:
Summarizes missing service references, renamed timers, and suggested documentation fixes for maintainers.
Security Audit
High RiskThe static findings are false positives caused by markdown backticks, regex examples, and references to .env.example. Semantic review found one real risk: the skill suggests running target repository scripts to inspect CLI help, which can execute untrusted code. No prompt injection attempt was found.
Confirmed security concerns (1)
Risk Factors
⚙️ External commands (19)
🔑 Env variables (2)
Share & cite this report
Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.
Copy report link
https://skillstore.io/skills/2389-research-documentation-audit/audits/6?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/2389-research-documentation-audit?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/2389-research-documentation-audit?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/2389-research-documentation-audit/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/2389-research-documentation-audit.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Academic citations (APA · BibTeX · CFF)
APA citation
2389-research. (2026). documentation-audit security audit report (audit version 6) [Author version unspecified]. Skillstore. https://skillstore.io/skills/2389-research-documentation-audit/audits/6BibTeX citation
@techreport{2389-research-2389-research-documentation-audit-2026,
author = {2389-research},
title = {documentation-audit security audit report (audit version 6)},
institution = {Skillstore},
year = {2026},
number = {6},
url = {https://skillstore.io/skills/2389-research-documentation-audit/audits/6},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "documentation-audit security audit report (audit version 6)"
version: "unspecified"
type: report
authors:
- name: "2389-research"
date-released: "2026-07-04"
url: "https://skillstore.io/skills/2389-research-documentation-audit/audits/6"
identifiers:
- type: other
value: "skillstore:2389-research-documentation-audit:audit:6"
description: "Skillstore immutable audit report identifier"
Skillstore Score
Why this score Evidence Confidence: MediumWhat You Can Build
Release Documentation Gate
Check user-facing docs before release and identify stale claims that could mislead users.
Post-Refactor Docs Review
Verify that renamed files, settings, services, and CLI options are reflected in documentation.
Documentation Debt Triage
Group false claims by pattern so teams can fix high-impact documentation drift first.
Try These Prompts
Use documentation-audit to check README.md against the current repository. List false claims, uncertain claims, and evidence for each result.
Use documentation-audit on README.md and docs/*.md. Focus on file references, configuration defaults, environment variables, CLI flags, and timing claims.
Use documentation-audit to extract claims from user-facing docs, verify them, then search for related patterns from every false claim. Produce an audit report.
Use documentation-audit before release. Compare documented scripts, services, config values, and CLI options with the codebase. Include blockers and human-review items.
Best Practices
- Audit user-facing docs first and exclude plans or historical notes unless requested.
- Keep file and line evidence beside every true, false, and uncertain verdict.
- Run pattern expansion after the first false claims are grouped.
Avoid
- Treating plausible prose as verified without checking source evidence.
- Running target project scripts just to inspect help text outside a sandbox.
- Mixing historical plans with current user documentation in the same audit.
Frequently Asked Questions
What does this skill audit?
Does it edit documentation?
Can it verify behavior claims?
Which AI tools can use it?
Is it safe for untrusted repositories?
What output should I expect?
Developer Details
Author
2389-researchLicense
MIT
Skillstore revision
r1
Version notice
The author did not declare a version.
Ref
14dc8f201a64f8d30fd131d7f036cd5e788be523
Maintenance freshness
7/18/2026
Usage
15 downloads · 194 views
File structure