Skip to content
TrustedSkillsbeta
Back to all skills

Api Documentation Writer

Listed
eddiebe147·vlatest·writing

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

Repository

Install on your platform

This skill no longer installs under the name api-documentation-writer. eddiebe147/claude-settings is deleted or private, so it cannot be installed from.

We check each listing against its upstream repository with the rules the skills CLI uses, last on 2026-10-22. We don't show a command we know will fail.

Repository install instructions

What we know about this skill

Publisher

eddiebe147

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.

Nobody has reviewed this code. TrustedSkills indexes and links skills; it does not audit, run or scan them. A skill runs with whatever access you give your agent — read the source before you install it.

Automated safety checks

scanned

We could not read this skill's source, so none of the checks below were run.

Not scanned. repository not found or private Source recorded as eddiebe147/claude-settings.
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

What it does

This skill assists in creating comprehensive and developer-friendly API documentation. It focuses on generating clear explanations, complete details of parameters and responses (including edge cases), and ensuring documentation remains synchronized with the API's behavior. The skill supports OpenAPI/Swagger specifications and provides guidance for authentication, code examples in multiple languages, and overall developer experience best practices.

When to use it

  • When creating initial API documentation from scratch.
  • To update existing API documentation to reflect changes in endpoints or functionality.
  • To ensure consistent formatting and adherence to documentation standards (Clear, Complete, Current).
  • For generating code examples for developers using the API.
  • When needing to document error codes and provide remediation steps.

Key capabilities

  • Generates OpenAPI/Swagger specifications.
  • Documents endpoint requests and responses with examples.
  • Provides guidance on authentication methods.
  • Includes code examples in popular programming languages (specific languages not listed).
  • Supports documenting error codes and remediation steps.
  • Adheres to the "Three C's" of documentation: Clear, Complete, Current.

Example prompts

  • “Generate OpenAPI documentation for my /users endpoint.”
  • “Document the authentication process for accessing the API.”
  • “Create a code example in Python showing how to list users with pagination.”

Tips & gotchas

  • The skill is designed to document public endpoints, not internal or private ones.
  • Ensure you provide sufficient context about your domain; avoid assuming readers have prior knowledge.
  • Regularly review and update the documentation to prevent it from drifting away from the actual API implementation.