api-documentation
AxlZero21/Skills/api-documentation/SKILL.md
OpenAPI/Swagger specification standards and API documentation best practices
One search for your own team's files and the public ecosystem. See how real projects write their agent instructions, and bring the good ideas home.
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
AxlZero21/Skills/api-documentation/SKILL.md
OpenAPI/Swagger specification standards and API documentation best practices
batur/ts-baseline-docs/.agents/skills/documentation-adr/SKILL.md
Use this skill when creating, updating, or reviewing repository documentation, ADRs, engineering standards, architecture docs, Mermaid diagrams, README onboarding, Copilot instructions, or documentation changes required by architecture/API/security/database/auth/deployment decisions in TypeScript software projects.
jgeorgeai11/claude_code_resources/.claude/skills/sas-documentation/SKILL.md
Document or review SAS files against project conventions. First step of the SAS conversion workflow — the documentation is what sas-conversion-planning plans from. Use when documenting one or more SAS files or reviewing existing SAS documentation; each file is handled in its own parallel pass and gets its own documentation file.
OpenBun/Skills/api-documentation/SKILL.md
Automatically generate comprehensive API documentation from a codebase or spec — covering REST, GraphQL, and WebSocket APIs. Use this skill whenever the user wants to document an API, analyze routes/resolvers/handlers to extract endpoints, create Swagger/OpenAPI specs or Postman collections, add JSDoc comments, set up Swagger UI, write authentication guides, document error codes, pagination, filtering, or rate limiting. Trigger for requests like document this API, write API docs, set up swagger, add JSDoc, generate OpenAPI, create a Postman collection, document my GraphQL schema, document my WebSocket events, or when a user shares any API code and asks how to document it.
PMDevSolutions/Nerva/.claude/skills/api-documentation/SKILL.md
Generates OpenAPI 3.1 specification from the Hono app and Zod schemas, sets up interactive API documentation using Scalar UI, generates Postman collections, and creates API quickstart documentation. Uses @hono/zod-openapi for spec generation. Keywords: openapi, swagger, documentation, docs, scalar, postman, collection, spec, api-reference, interactive, ui, endpoint, schema, quickstart, hono-zod-openapi
yiweiwan/skills/.claude/skills/api-documentation/SKILL.md
Use only when writing or improving API documentation, endpoint references, REST docs, GraphQL docs, SDK docs, authentication docs, request and response examples, error codes, rate limits, pagination, and integration guides.
zekhoi/claude/.agents/skills/kit-documentation/SKILL.md
Write or update project documentation such as READMEs, setup and usage guides, and API references so it matches what the code actually does, with every command and example verified. Use when the user asks to write, update, or fix documentation, a README, or usage instructions. Do not use for code comments during feature work, changelogs for releases, or explaining code to the user in chat.
murphytrueman/design-system-ops/skills/pattern-documentation/SKILL.md
Document a multi-component pattern (form validation, empty states, error handling): when to use, composition, states, a11y, anti-patterns. Triggers: document this pattern, write the pattern page. One named component: use usage-guidelines. Choosing a component: component-decision-tree.
Fmarzochi/EGC/.cursor/skills/documentation-lookup/SKILL.md
Use up-to-date library and framework docs via Context7 MCP instead of training data. Activates for setup questions, API references, code examples, or when the user names a framework (e.g. React, Next.js, Prisma).
Often used witheverything-claude-code-conventionsagent-sortmle-workflow
Indium-AI-Labs/indium-agentkit/skills/write-documentation/SKILL.md
Write or update project documentation from code evidence: READMEs, tutorials, how-to guides, reference pages, explanations, and architecture decision records, running each documented command or marking it unverified. Use when asked to document a feature, API, CLI, configuration, or design decision, fix stale or broken docs, or write an ADR. Not for onboarding guides (use the onboard-to-codebase skill) or AGENTS.md and CLAUDE.md files (use the init-agent-context skill).
shashankswe2020-ux/whoop-mcp/.github/skills/documentation-and-adrs/SKILL.md
Records decisions and documentation. Use when making architectural decisions, changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.
Often used withconstraint-driven-developmentdeprecation-and-migrationdoubt-driven-development
anwather/epac-skills/skills/epac-documentation/SKILL.md
Create and optionally run EPAC policy documentation configurations for assignment reports and policy set comparisons. Use when asked to generate, configure, scaffold, build, or update policyDocumentations JSON/JSONC files, document all or representative Azure Policy assignments, compare initiatives, or run Build-PolicyDocumentation.
IgorBabikov/Flowcairn/skills/core-documentation/SKILL.md
Обновление документации измененного поведения, контрактов и ограничений.
jabrena/cursor-rules-java/skills/170-java-documentation/SKILL.md
Use when you need to generate or improve Java project documentation — including README.md files, package-info.java files, and Javadoc enhancements — through a modular, step-based interactive process that adapts to your specific documentation needs. This should trigger for requests such as Improve the code with documentation; Apply documentation; Refactor the code with documentation; Generate README or developer documentation for a Java project; Document Java APIs architecture or project workflows. Part of Plinth Toolkit
Yassimba/loom/skills/write-documentation/SKILL.md
Write software documentation structured by Diátaxis. Use when the user wants a tutorial, how-to guide, reference page, explanation doc, or user guide — "write docs", "document this", "we need a guide for X". Not for READMEs (write-readme) or docstrings (update-docstrings).
canonical/snapcraft/.github/skills/documentation-structure/SKILL.md
Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references. Use when checking documentation organization or validating toctree structure.
Steady3 mentions in 2 weeks
2 projects use a version of this
ProjAnvil/MindForge/skills/en/tech-documentation/SKILL.md
Technical documentation writing skill covering API docs, architecture documentation, deployment guides, and various technical writing best practices. Use this skill when creating technical documentation, writing API documentation, creating architecture design documents, or need templates for deployment and operations manuals.
ProjAnvil/MindForge/skills/zh-cn/tech-documentation/SKILL.md
技术文档编写技能,涵盖 API 文档、架构文档、部署指南和各种技术写作最佳实践。使用此技能创建技术文档、编写 API 文档、创建架构设计文档,或需要部署和运维手册模板时使用。
tmcfarlane/team-avatar/skills/documentation-writing/SKILL.md
Writing clear, discoverable software documentation following the Eight Rules and Diataxis framework. Use when creating README files, API docs, tutorials, how-to guides, or any project documentation. Automatically enforces docs/ location, linking requirements, and runnable examples.
muratgur/ordinus/.claude/skills/documentation-and-adrs/SKILL.md
Records decisions and documentation. Use when making architectural decisions, changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.
Often used withconstraint-driven-developmentdeprecation-and-migrationdoubt-driven-development
Plain text files in a repository that tell a coding agent how the project works: commands to run, conventions to follow and things to avoid. CLAUDE.md, AGENTS.md, cursor rules and skills are the common kinds.
CLAUDE.md is read by Claude Code. AGENTS.md is an open format that Codex, Cursor and other agents read. Many projects keep one and point the other at it.
A folder with a SKILL.md that describes one capability, such as filling PDFs or reviewing code. The agent loads it only when the task calls for it.
Your agents already can, over MCP, limited to the files you're allowed to read. Searching them from this page is coming.