界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
文档与办公 · SKILL.md

api-docs-writer

api-docs-writer

【文档与办公】Write reference documentation for an HTTP endpoint from its handler code: parameters, responses, errors.

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

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

  1. Read the input the user points to. If none is given, ask for the file or text.
  2. Do the task described above, step by step, and keep the user's own wording where it matters.
  3. 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.
我的收藏