Skip to content
Back to skills

Guide Write

ASecurity

Write API reference documentation for an endpoint or SDK method.

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

Works with

  • api

Security analysis

A100/100

Scanned May 27, 2026

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

Installs into .claude/skills of the current project.

Are you the author of Guide Write?

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

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

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-write
description: Write API reference documentation for an endpoint or SDK method.
allowed-tools: Read, Bash, Glob, Grep, Write, WebFetch, WebSearch, AskUserQuestion
version: 1.6.0
author: tonone-ai <hello@tonone.ai>
license: MIT
---

# Guide Write

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

Gather the API spec (OpenAPI, function signature, or description), response schema, and error codes.

### Step 2: Produce Output

Output production-ready docs: description, parameters table (name/type/required/description/example), response schema, error codes, and a working code example in the target language.

### 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…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.