technical-docs

Document each endpoint with its HTTP method and path, required headers like Authorization and Content-Type, a JSON request body example, and a response example with its status code. Include runnable curl or code snippets and define domain terms in a glossary.

The Divio system splits documentation into four modes: Tutorials (learning-oriented), How-To Guides (goal-oriented steps), Reference (complete, dense information), and Explanation (background and context). Keeping these modes separate prevents docs from confusing readers.

List prerequisites first (runtime versions, environment variables, API keys), then give sequential single-action steps: install dependencies, initialize the client, and execute one operation with expected output. Every code snippet must be tested and runnable.

No. Developer docs can assume technical vocabulary and prioritize precision with code examples, while end-user guides assume minimal technical knowledge and stay task-oriented. Executive summaries drop technical detail entirely and focus on business outcomes.

Use a different skill for repository README and CONTRIBUTING files, internal standard operating procedures, or designing OpenAPI specification schemas in YAML. This skill targets developer-facing documentation content, not API schema design.