Works with the AI Agents you already use
Claude Code
Cursor
Codex CLI
Muse
Dots+21 moreClaude CodeCursorCodex CLIMuseDots
Manus
Grok
Grok Bot+18 agentsTechnical Documentation Gap Auditor
Audits technical documentation for gaps, staleness, and structural issues to create a prioritized fix plan.
$15
Technical Documentation Gap Auditor
Example session with this skill installed
Perform a Quick Audit on this README.md. It feels outdated and users are complaining that the setup steps don't work on the latest version of Node.
- Read your context and instructions
- Compiled the technical documentation gap
I have completed a Quick Audit of your README.md. The documentation health score is 4.2/10, primarily due to stale installation instructions and missing environment prerequisites.
Documentation Audit Report
Executive Summary
Health Score: 4.2/10
Top Risks: The installation guide references deprecated Node.js versions and lacks mandatory environment variable setup, leading to immediate failure for new users. Fixes will reduce "setup failed" support tickets by an estimated 70%.
Findings Register
| ID | Severity | Dimension | Location | Evidence | User Impact | Fix |
|---|---|---|---|---|---|---|
| DG-001 | Critical | Freshness | # Installation | "Requires Node v12" | Setup fails on modern LTS versions. | Update to "Node.js 18.x or higher". |
| DG-002 | High | Coverage | # Configuration | No mention of .env.local | App crashes on start with "Missing API Key". | Add section on environment variables. |
| DG-003 | Medium | Clarity | # Usage | "Run the worker" | Users don't know which CLI command to use. | Change to npm run start:worker. |
Fix Pack
# Quick Start
## Prerequisites
- Node.js 18.x or higher
- A valid API Key from the [Dashboard](https://example.com/settings) [OWNER-VERIFY]
## Installation
1. Clone the repository:
```bash
```bash
git clone https://github.com/org/project.git
2. Install dependencies:
```bash
npm install
- Set up environment variables:
cp .env.example .env.local # Edit .env.local with your API_KEY - Start the development server:
npm run dev
**Next steps**
1. Verify the minimum supported Node.js version and update the [OWNER-VERIFY] tag in the Quick Start.
2. Verify if `npm install` requires any native build tools for your specific environment.
3. Replace the placeholder Dashboard link with the actual URL.
Connects securely to your tools. The creator never sees your data.
About this skill
Technical documentation is often the biggest bottleneck in developer onboarding and product adoption. This skill audits your existing documentation—including READMEs, API references, and developer guides—to identify missing information, stale code, and structural friction. It moves beyond simple grammar checks to evaluate docs based on the Diataxis model, cross-referencing your documentation against your actual codebase to find contradictions.
What it does
- Gap analysis identifies missing prerequisites, error codes, and troubleshooting steps that cause support tickets.
- Accuracy verification cross-checks function names, flags, and config keys against your source code or repository tree.
- Health scoring provides a 0-10 rating across ten dimensions including freshness, onboarding speed, and task completeness.
- Architecture design creates a prioritized documentation hierarchy and navigation tree based on modern technical writing frameworks.
- Fix generation produces ready-to-paste rewrites, corrected code blocks, and new Quick Start guides.
How it works
- Inventory & Map: The skill identifies your documentation types and maps them to specific user personas and goals.
- Audit & Score: It executes a multi-point audit, scoring dimensions like coverage and clarity while tagging findings by severity.
- Architecture & Fix: It proposes a new documentation structure and generates drafts for the most critical missing sections.
- Roadmap: It delivers a 30/60/90-day plan focused on quick wins, structural fixes, and documentation automation.
Frameworks & tools
This skill utilizes the Diataxis documentation framework and adheres to docs-as-code principles. It supports Markdown, OpenAPI/Swagger specs, HTML, and plain text inputs.
Why this beats prompting it yourself
Generic prompts often miss the technical nuances of documentation, like the distinction between reference and tutorial content. This skill uses a specialized taxonomy and scoring system to ensure every finding is backed by evidence and tagged for owner verification rather than hallucinated.
Use cases
- README Doctor: Fast-track a repository's first impression by auditing the landing page and Quick Start.
- API Review: Audit endpoint documentation for missing parameters, incorrect types, or missing error responses.
- Onboarding Audit: Identify why new hires or users struggle to reach their first success with your tool.
- Support-Driven Audit: Supply support ticket excerpts to map recurring user pain points back to specific documentation gaps.
Known limitations
This skill reviews documentation quality only. It does not execute code, test live APIs, or provide legal advice on licenses. Findings are limited to the material and code trees provided.
Does not execute code or test live systems. Compliance flags are quality checks, not legal advice. Limited to provided files and repository trees.
How to use
- 1
Connect your agent to the Agensi MCP
Copy the prompt and paste it into Claude, ChatGPT, Cursor or any agent that supports MCP. It sets up the connection for you. Manual setup
- 2
Sign in to Agensi
Your agent shows a sign-in link. Sign in and click Allow.
- 3
Ask for what you need
Your agent loads this skill and uses it on your task. It always asks before any payment.
Reviews
No reviews yet
Be one of the first to try it. Every listed skill goes through the trust checks below.
Security scanned
Checked by our 8-point scan before listing
Fresh listing
Recently published to Agensi
Money-back guarantee
Doesn't do what its page promises? You get your money back.
Trust & safety
Security scan
Security scan passed today
Requires
Python