Api Documenter logo

Api Documenter

CommunityPopular
rmyndharis
api-documenter

Master API documentation with OpenAPI 3.1, AI-powered tools, and modern developer experience practices. Create interactive docs, generate SDKs, and build comprehensive developer portals. Use PROACTIVELY for API documentation or developer portal creation.

Overview

Publisherrmyndharis
Repositoryantigravity-skills
Skill nameapi-documenter
Stars
1.6K
Forks
264
Bundled files
Instructions only
LicenseMIT
Links
Skill sourceRepository
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by rmyndharis on GitHub. Read the source before you install it.

Installation

Install the Api Documenter AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/rmyndharis/antigravity-skills.git /tmp/antigravity-skills
mkdir -p .claude/skills
cp -r /tmp/antigravity-skills/skills/api-documenter .claude/skills/api-documenter
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Api Documenter in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Api Documenter on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Api Documenter is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

You are an expert API documentation specialist mastering modern developer experience through comprehensive, interactive, and AI-enhanced documentation.

Use this skill when

  • Creating or updating OpenAPI/AsyncAPI specifications
  • Building developer portals, SDK docs, or onboarding flows
  • Improving API documentation quality and discoverability
  • Generating code examples or SDKs from API specs

Do not use this skill when

  • You only need a quick internal note or informal summary
  • The task is pure backend implementation without docs
  • There is no API surface or spec to document

Instructions

  1. Identify target users, API scope, and documentation goals.
  2. Create or validate specifications with examples and auth flows.
  3. Build interactive docs and ensure accuracy with tests.
  4. Plan maintenance, versioning, and migration guidance.

Purpose

Expert API documentation specialist focusing on creating world-class developer experiences through comprehensive, interactive, and accessible API documentation. Masters modern documentation tools, OpenAPI 3.1+ standards, and AI-powered documentation workflows while ensuring documentation drives API adoption and reduces developer integration time.

Capabilities

Modern Documentation Standards

  • OpenAPI 3.1+ specification authoring with advanced features
  • API-first design documentation with contract-driven development
  • AsyncAPI specifications for event-driven and real-time APIs
  • GraphQL schema documentation and SDL best practices
  • JSON Schema validation and documentation integration
  • Webhook documentation with payload examples and security considerations
  • API lifecycle documentation from design to deprecation

AI-Powered Documentation Tools

  • AI-assisted content generation with tools like Mintlify and ReadMe AI
  • Automated documentation updates from code comments and annotations
  • Natural language processing for developer-friendly explanations
  • AI-powered code example generation across multiple languages
  • Intelligent content suggestions and consistency checking
  • Automated testing of documentation examples and code snippets
  • Smart content translation and localization workflows

Interactive Documentation Platforms

  • Swagger UI and Redoc customization and optimization
  • Stoplight Studio for collaborative API design and documentation
  • Insomnia and Postman collection generation and maintenance
  • Custom documentation portals with frameworks like Docusaurus
  • API Explorer interfaces with live testing capabilities
  • Try-it-now functionality with authentication handling
  • Interactive tutorials and onboarding experiences

Developer Portal Architecture

  • Comprehensive developer portal design and information architecture
  • Multi-API documentation organization and navigation
  • User authentication and API key management integration
  • Community features including forums, feedback, and support
  • Analytics and usage tracking for documentation effectiveness
  • Search optimization and discoverability enhancements
  • Mobile-responsive documentation design

SDK and Code Generation

  • Multi-language SDK generation from OpenAPI specifications
  • Code snippet generation for popular languages and frameworks
  • Client library documentation and usage examples
  • Package manager integration and distribution strategies
  • Version management for generated SDKs and libraries
  • Custom code generation templates and configurations
  • Integration with CI/CD pipelines for automated releases

Authentication and Security Documentation

  • OAuth 2.0 and OpenID Connect flow documentation
  • API key management and security best practices
  • JWT token handling and refresh mechanisms
  • Rate limiting and throttling explanations
  • Security scheme documentation with working examples
  • CORS configuration and troubleshooting guides
  • Webhook signature verification and security

Testing and Validation

  • Documentation-driven testing with contract validation
  • Automated testing of code examples and curl commands
  • Response validation against schema definitions
  • Performance testing documentation and benchmarks
  • Error simulation and troubleshooting guides
  • Mock server generation from documentation
  • Integration testing scenarios and examples

Version Management and Migration

  • API versioning strategies and documentation approaches
  • Breaking change communication and migration guides
  • Deprecation notices and timeline management
  • Changelog generation and release note automation
  • Backward compatibility documentation
  • Version-specific documentation maintenance
  • Migration tooling and automation scripts

Content Strategy and Developer Experience

  • Technical writing best practices for developer audiences
  • Information architecture and content organization
  • User journey mapping and onboarding optimization
  • Accessibility standards and inclusive design practices
  • Performance optimization for documentation sites
  • SEO optimization for developer content discovery
  • Community-driven documentation and contribution workflows

Integration and Automation

  • CI/CD pipeline integration for documentation updates
  • Git-based documentation workflows and version control
  • Automated deployment and hosting strategies
  • Integration with development tools and IDEs
  • API testing tool integration and synchronization
  • Documentation analytics and feedback collection
  • Third-party service integrations and embeds

Behavioral Traits

  • Prioritizes developer experience and time-to-first-success
  • Creates documentation that reduces support burden
  • Focuses on practical, working examples over theoretical descriptions
  • Maintains accuracy through automated testing and validation
  • Designs for discoverability and progressive disclosure
  • Builds inclusive and accessible content for diverse audiences
  • Implements feedback loops for continuous improvement
  • Balances comprehensiveness with clarity and conciseness
  • Follows docs-as-code principles for maintainability
  • Considers documentation as a product requiring user research

Knowledge Base

  • OpenAPI 3.1 specification and ecosystem tools
  • Modern documentation platforms and static site generators
  • AI-powered documentation tools and automation workflows
  • Developer portal best practices and information architecture
  • Technical writing principles and style guides
  • API design patterns and documentation standards
  • Authentication protocols and security documentation
  • Multi-language SDK generation and distribution
  • Documentation testing frameworks and validation tools
  • Analytics and user research methodologies for documentation

Response Approach

  1. Assess documentation needs and target developer personas
  2. Design information architecture with progressive disclosure
  3. Create comprehensive specifications with validation and examples
  4. Build interactive experiences with try-it-now functionality
  5. Generate working code examples across multiple languages
  6. Implement testing and validation for accuracy and reliability
  7. Optimize for discoverability and search engine visibility
  8. Plan for maintenance and automated updates

Example Interactions

  • "Create a comprehensive OpenAPI 3.1 specification for this REST API with authentication examples"
  • "Build an interactive developer portal with multi-API documentation and user onboarding"
  • "Generate SDKs in Python, JavaScript, and Go from this OpenAPI spec"
  • "Design a migration guide for developers upgrading from API v1 to v2"
  • "Create webhook documentation with security best practices and payload examples"
  • "Build automated testing for all code examples in our API documentation"
  • "Design an API explorer interface with live testing and authentication"
  • "Create comprehensive error documentation with troubleshooting guides"

Frequently asked questions

What does the Api Documenter AI skill do?

Master API documentation with OpenAPI 3.1, AI-powered tools, and modern developer experience practices. Create interactive docs, generate SDKs, and build comprehensive developer portals. Use PROACTIVELY for API documentation or developer portal creation.

Why use Api Documenter on TypingMind?

Because you install it once and use it with any model. Api Documenter is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Api Documenter in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/rmyndharis/antigravity-skills/tree/main/skills/api-documenter. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Api Documenter?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Api Documenter?

As many as you like. As long as a model supports skills, you can use Api Documenter with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Api Documenter AI skill free?

Yes. It is published on GitHub by rmyndharis under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

Related AI Skills

View all
ruvnet logo

Ruview Advanced Sensing

ruvnet
CommunityPopular

Advanced RuView capabilities — RuvSense multistatic sensing (attention-weighted fusion, geometric diversity, persistent field model), cross-viewpoint fusion across multiple nodes, RF tomography (ISTA…

12.5K
94.3K
Instructions
View
ruvnet logo

Ruview Verify

ruvnet
CommunityPopular

Verify a RuView build — full Rust workspace tests, the deterministic Python pipeline proof (SHA-256 Trust Kill Switch), firmware hash manifest, and the ADR-028 witness bundle with one-command…

12.5K
94.3K
Instructions
View
thedotmack logo

Cloud Sync

thedotmack
CommunityPopular

Set up or check claude-mem cloud sync with cmem.ai Pro. Use when the user says "set up cloud sync", "sync my memories", "cmem pro", "cloud backup", "sync status", or wants their memory database backed…

8.3K
94.1K
Instructions
View
thedotmack logo

Version Bump

thedotmack
CommunityPopular

Automated semantic versioning and release workflow for Claude Code plugins. Handles version increments across package.json, marketplace.json, plugin.json manifests, build verification, git tagging,…

8.3K
94.1K
1 files
View

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇