analyzing-docs
Audit Documentation Quality and Coverage
Incomplete documentation makes code harder to use, maintain, and review. This skill measures coverage and quality, identifies gaps, and prioritizes improvements.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Review the Skillstore skill "analyzing-docs" from https://skillstore.io/skills/c0ntr0lledcha0s-analyzing-docs.md and its manifest at https://skillstore.io/api/skills/c0ntr0lledcha0s-analyzing-docs/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.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 "analyzing-docs". Assess documentation coverage for the public API.
Expected outcome:
Overall coverage: 72%. Public classes are well documented, but exported functions lack parameter details. Prioritize authentication and error-handling APIs.
Using "analyzing-docs". Score the quality of the developer guide.
Expected outcome:
- Completeness: 7/10. Setup and deployment are covered, but troubleshooting is missing.
- Accuracy: 8/10. Commands match the current project configuration.
- Clarity: 6/10. Several sections use undefined terms.
- Usefulness: 7/10. Add failure examples and recovery steps.
Using "analyzing-docs". Identify the most urgent documentation gaps.
Expected outcome:
Critical gaps: undocumented public methods, missing security warnings, and outdated request examples. Address public API contracts before formatting inconsistencies.
Security Audit
SafeAll 13 static findings are false positives. Eleven matches are Markdown fences or fixed, read-only grep examples, while two reconnaissance matches are ordinary documentation checklist phrases.
Risk Factors
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/c0ntr0lledcha0s-analyzing-docs/audits/10?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/c0ntr0lledcha0s-analyzing-docs?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/c0ntr0lledcha0s-analyzing-docs?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/c0ntr0lledcha0s-analyzing-docs/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/c0ntr0lledcha0s-analyzing-docs.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
C0ntr0lledCha0s. (2026). analyzing-docs security audit report (audit version 10) [Author version unspecified]. Skillstore. https://skillstore.io/skills/c0ntr0lledcha0s-analyzing-docs/audits/10BibTeX citation
@techreport{c0ntr0lledcha0s-c0ntr0lledcha0s-analyzing-docs-2026,
author = {C0ntr0lledCha0s},
title = {analyzing-docs security audit report (audit version 10)},
institution = {Skillstore},
year = {2026},
number = {10},
url = {https://skillstore.io/skills/c0ntr0lledcha0s-analyzing-docs/audits/10},
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: "analyzing-docs security audit report (audit version 10)"
version: "unspecified"
type: report
authors:
- name: "C0ntr0lledCha0s"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/c0ntr0lledcha0s-analyzing-docs/audits/10"
identifiers:
- type: other
value: "skillstore:c0ntr0lledcha0s-analyzing-docs:audit:10"
description: "Skillstore immutable audit report identifier"
Skillstore Score
Why this score Evidence Confidence: HighWhat You Can Build
Assess Release Readiness
Review public API documentation before a release and identify critical omissions.
Plan Documentation Work
Measure documentation gaps and create a prioritized improvement backlog.
Evaluate Repository Health
Compare documentation coverage and quality across modules or repositories.
Try These Prompts
Review the documentation in [path]. List the most important gaps and explain their impact.
Analyze [repository] and calculate documentation coverage for functions, classes, modules, and project guides. Show counts and percentages.
Assess documentation in [path] for completeness, accuracy, clarity, and usefulness. Score each dimension from 0 to 10 with evidence.
Audit [repository] documentation. Measure coverage, score quality, identify critical gaps, compare modules, and recommend prioritized actions with measurable targets.
Best Practices
- Define the repository scope and documentation audience before analysis.
- Validate documentation claims against current code and runnable examples.
- Support every score with file-specific evidence and prioritized recommendations.
Avoid
- Do not treat comment counts as proof of useful documentation.
- Do not average scores without explaining critical omissions.
- Do not recommend broad rewrites when focused updates can close measured gaps.
Frequently Asked Questions
What documentation does this skill evaluate?
How is documentation coverage calculated?
Which quality dimensions are scored?
Does the skill modify documentation files?
Which programming languages have included search patterns?
Can the scores compare repositories?
Developer Details
Author
C0ntr0lledCha0sLicense
MIT
Skillstore revision
r2
Version notice
The author did not declare a version.
Ref
a39a91716eadede5f4cdefd78178fed4e837a128
Maintenance freshness
7/24/2026
Usage
8 downloads · 166 views
File structure
📄 SKILL.md