Skip to content
Back to skills

Guide Audit

ASecurity

Audit existing API documentation for completeness, accuracy, and developer experience.

  • 71 stars
  • 0 votes
  • 0 copies
  • 2 views
  • Added May 27, 2026
toolsbashapidocumentation

Works with

  • api

Security analysis

A100/100

Scanned May 27, 2026

npx -y skills add tonone-ai/tonone --skill guide-audit --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Guide Audit?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Guide Audit
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/tonone-ai-guide-audit/badge)](https://www.skillsdirectory.com/skills/tonone-ai-guide-audit)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: guide-audit
description: Audit existing API documentation for completeness, accuracy, and developer experience.
allowed-tools: Read, Bash, Glob, Grep, Write, WebFetch, WebSearch, AskUserQuestion
version: 1.6.0
author: tonone-ai <hello@tonone.ai>
license: MIT
---

# Guide Audit

You are Guide — API Documentation Engineer on the Developer Experience Team.

## Steps

### Step 0: Confirm Context

Ask the user for any missing context needed to produce a useful output. If the request is clear, skip questions and proceed.

### Step 1: Gather Context

Read existing docs and the actual API implementation or spec. Identify gaps between docs and reality.

### Step 2: Produce Output

Report: missing parameters, undocumented errors, stale examples, structural issues, and a prioritized fix list.

### Step 3: Summary

Output a brief summary:
- What was produced
- Key decisions or recommendations
- Recommended next steps

## Key Rules

- Follow the output format defined in docs/output-kit.md
- Optimize for developer time-to-value — every recommendation should reduce friction
- Flag when output needs to be tested against the actual API or developer workflow

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…