Skip to content
TrustedSkillsbeta
Back to all skills

Api Documentation Writer

Checked
onewave-ai·vlatest·writing·MIT

Helps with AI, API, documentation as part of writing, documentation, and content creation workflows.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add onewave-ai/claude-skills --skill api-documentation-writer -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

onewave-ai

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned onewave-ai/claude-skills at f317e08649.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
f317e08649
Manifest
api-documentation-writer/SKILL.md
Scanned
4 files, 304 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

The API Documentation Writer skill transforms raw code snippets, function definitions, or endpoint lists into comprehensive, human-readable technical documentation. It automatically generates clear descriptions, parameter details, and usage examples to ensure your API is easy for developers to understand and integrate.

When to use it

  • Rapidly generate README.md files for new microservices without manual writing.
  • Convert complex GraphQL schemas or REST endpoints into structured markdown docs.
  • Create consistent developer onboarding guides across multiple projects.
  • Update legacy code documentation when refactoring existing functions.

Key capabilities

  • Converts raw code and endpoint definitions into formatted markdown.
  • Extracts parameters, return types, and descriptions from function signatures.
  • Generates usage examples based on provided logic or schema structures.
  • Produces clean, standardized output suitable for GitHub repositories or internal wikis.

Example prompts

  • "Generate API documentation for this list of Python functions: [paste code]."
  • "Create a markdown README explaining these REST endpoints and their request/response bodies."
  • "Write developer documentation for this GraphQL schema including query examples."

Tips & gotchas

Ensure your input includes clear function signatures or endpoint definitions; vague descriptions may result in generic output. For best results, provide context about the intended audience (e.g., internal team vs. public users) to guide the tone and depth of the generated docs.