- name
- api-docs-writer
- description
- Write reference documentation for an HTTP endpoint from its handler code: parameters, responses, errors.
Api Docs Writer
Write reference documentation for an HTTP endpoint from its handler code: parameters, responses, errors.
When to use
Use this skill when the user asks for it by name or describes this task. Do not use it for unrelated work.
Steps
- Read the input the user points to. If none is given, ask for the file or text.
- Do the task described above, step by step, and keep the user's own wording where it matters.
- Show the result, then a short list of what you changed or found, so the user can check it.
Notes
- Keep changes small and reversible.
- Say plainly when the input is incomplete instead of guessing.