⚡AgentSkills
✍️ Technical Writing · API Reference & Guides

Document endpoints developers can copy-paste

Every endpoint documented with working request, realistic response, and error table.

intermediate~30 minTechnical WritersDeveloper AdvocatesEngineers Who Document

Steps

  1. 1Lead with minimal working request using realistic sandbox data
  2. 2Show full response body, not truncated ellipses
  3. 3Error section lists codes with causes AND fixes
  4. 4Note rate limits, auth scopes, and idempotency behavior inline
  5. 5Provide copyable snippets in three top languages minimum
  6. 6Test every example in CI against staging nightly

Common Pitfalls

  • ▲Examples with fake keys that fail when tried
  • ▲Parameter tables without units or formats

Commands

Install with skills CLI
$ npx skills add aniruddhaadak80/skills --skill api-reference-endpoint-doc-pattern
Install globally
$ npx skills add aniruddhaadak80/skills --skill api-reference-endpoint-doc-pattern -g

Tags

#api-docs#openapi#technical-writing#api-reference

Related skills

Write tutorials people actually finishintermediate

Fast first win, verifiable checkpoints, and failure exits keeping momentum.

✍️ Technical Writing·~35m
Open →