Api Documentation Writer

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.