Agent skill

API Documentation Writer

by captainflasmr in captainflasmr/ollama-buddy

Create clear, comprehensive API documentation with examples and error handling.

GPL-3.0Auto-check passedDevelopment

Install API Documentation Writer

skills CLI
$ npx skills add captainflasmr/ollama-buddy --skill api-documentation-writer -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install captainflasmr/ollama-buddy api-documentation-writer --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/captainflasmr/ollama-buddy.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/api-documentation-writer .claude/skills/api-documentation-writer && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
api-documentation-writer
GitHub stars
103
Token cost
~326 tokens
SKILL.md length
134 words
Files
1
Skills in repo
12
Repo updated
First seen
Licence
GPL-3.0

At a glance

Create clear, comprehensive API documentation with examples and error handling.

  • Works in 5 steps: Provide concise overviews of… → Include complete, accurate details about… → Show practical examples of common use… → …
  • Phrases like api documentation
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Document this api

What it does

API Documentation Writer is an agent skill from captainflasmr/ollama-buddy. Create clear, comprehensive API documentation with examples and error handling. Trigger on phrases like "api documentation", "document this api", "write api docs", "api reference", "api endpoint documentation".

Its SKILL.md is about 330 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. The repository describes itself as: A friendly Emacs interface for interacting with Ollama models. The licence is GPL-3.0.

When your agent uses it

  • Phrases like api documentation
  • Document this api
  • Api endpoint documentation

Example prompts

  • “api documentation”
  • “document this api”
  • “write api docs”
  • “/api-documentation-writer”

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

  1. Provide concise overviews of functionality and purpose
  2. Include complete, accurate details about endpoints, parameters, and return values
  3. Show practical examples of common use cases
  4. Address error handling and edge cases
  5. Use consistent terminology and formatting

What it can do on your machine

Read from SKILL.md and the folder at commit 12eaf7f. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

API Documentation Writer loads about 326 tokens when it runs. Until then it costs about 59 tokens; SKILL.md has 134 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~59
When it runs · the whole SKILL.md, loaded when a task matches
~326

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from captainflasmr/ollama-buddy at commit 12eaf7f, republished under its GPL-3.0 licence (© captainflasmr). 134 words, ~326 tokens.

Download SKILL.mdSave it as .claude/skills/api-documentation-writer/SKILL.md (or your agent's skills folder).
name
api-documentation-writer
description
Create clear, comprehensive API documentation with examples and error handling. Trigger on phrases like "api documentation", "document this api", "write api docs", "api reference", "api endpoint documentation".

API Documentation Writer

You are an API documentation specialist who creates clear, comprehensive documentation for software interfaces. Your documentation should:

  1. Provide concise overviews of functionality and purpose
  2. Include complete, accurate details about endpoints, parameters, and return values
  3. Show practical examples of common use cases
  4. Address error handling and edge cases
  5. Use consistent terminology and formatting

When creating API documentation:

  • Structure content logically with clear navigation
  • Include both quick reference and detailed explanations
  • Provide example requests and responses in multiple languages
  • Document authentication requirements and security considerations
  • Include status codes and error messages with their meanings

Balance technical completeness with readability, ensuring that documentation serves both new users who need guidance and experienced users who need quick reference. Use tables, code blocks, and other formatting to enhance clarity and scanability.

© captainflasmr, GPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/api-documentation-writer of captainflasmr/ollama-buddy.

Open the folder on GitHubat commit 12eaf7f

Compare with similar skills

API Documentation Writer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

API Documentation Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
API Documentation Writer this skillcaptainflasmr/ollama-buddy103—~326Automated safety check: PassGPL-3.0
Diagram Designcathrynlavery/diagram-design44k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k2 repos~775Automated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.4kAutomated safety check: PassGPL-3.0

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    44k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 2 repos~775 tokens
    DevelopmentAuto-check passed
  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.4k tokensUpdated today
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 5 days ago
    DevelopmentAuto-check: notes

More from captainflasmr/ollama-buddy

All 12 skills in this repo
  • Blog Writer

    captainflasmr/ollama-buddy

    Write an Emacs blog post in James Dyer's voice for www.emacs.dyerdwelling.family.

    103 GitHub stars~2.1k tokensUpdated 27 days ago
    Auto-check passed
  • Elisp Dev

    captainflasmr/ollama-buddy

    Assist with Emacs Lisp (elisp) development, debugging, and parenthesis matching.

    103 GitHub stars~2.7k tokensUpdated 27 days ago
    Auto-check passed
  • Elisp Review

    captainflasmr/ollama-buddy

    Review Emacs Lisp (elisp) packages for bugs, style/convention violations, and optimisation opportunities.

    103 GitHub stars~2.2k tokensUpdated 27 days ago
    Auto-check passed
  • Annotate Project

    captainflasmr/ollama-buddy

    Analyse a project's source code and generate a simply-annotate database file with LLM-created annotations categorised by tag: defun for functions and large syntactical blocks, line for smaller…

    103 GitHub stars~6.2k tokensUpdated 27 days ago
    Auto-check passed
  • Reddit Post Writer

    captainflasmr/ollama-buddy

    Write an r/emacs Reddit post in James Dyer's voice for announcing or discussing an Emacs package.

    103 GitHub stars~1.4k tokensUpdated 27 days ago
    Auto-check passed
  • Code Refactoring

    captainflasmr/ollama-buddy

    Expert code refactoring and optimization with analysis, improvements, and documentation.

    103 GitHub stars~446 tokensUpdated 27 days ago
    Auto-check passed

Categories

Questions about API Documentation Writer

What does API Documentation Writer do?

Create clear, comprehensive API documentation with examples and error handling. API Documentation Writer is an agent skill from captainflasmr/ollama-buddy. Create clear, comprehensive API documentation with examples and error handling.

When should I use API Documentation Writer?

API Documentation Writer fits situations like: phrases like api documentation; document this api; api endpoint documentation.

How do I install API Documentation Writer in Claude Code?

Run `npx skills add captainflasmr/ollama-buddy --skill api-documentation-writer -a claude-code`. Or copy the skill folder (.agents/skills/api-documentation-writer in captainflasmr/ollama-buddy) into .claude/skills/api-documentation-writer in your project. Claude Code loads it when a task matches its description.

How do I install API Documentation Writer in Codex?

Run `npx skills add captainflasmr/ollama-buddy --skill api-documentation-writer -a codex`. Or copy the skill folder (.agents/skills/api-documentation-writer in captainflasmr/ollama-buddy) into .agents/skills/api-documentation-writer in your project. Codex loads it when a task matches its description.

Can I use API Documentation Writer in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add captainflasmr/ollama-buddy --skill api-documentation-writer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-documentation-writer, .gemini/skills/api-documentation-writer, .github/skills/api-documentation-writer and .opencode/skills/api-documentation-writer in your project.

What does API Documentation Writer need to run?

SKILL.md names no scripts, command-line tools or credentials: API Documentation Writer is instructions for the agent only.

Does API Documentation Writer access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is API Documentation Writer safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does API Documentation Writer use?

API Documentation Writer is published under the GPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does API Documentation Writer use?

About 326 tokens (SKILL.md is roughly 1.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to API Documentation Writer?

Skills that share tags, products or a category with API Documentation Writer: Diagram Design (cathrynlavery/diagram-design, 44k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Documentation Writer?

captainflasmr (a GitHub user) maintains it in captainflasmr/ollama-buddy, which has 103 GitHub stars. The repository holds 12 skills in this directory. The repository was last updated on September 10, 2026.

Source: captainflasmr/ollama-buddy on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.