Technical documentation

Write technical documentation for its intended readers and their tasks. Follow repository-specific writing rules and document formats where they exist. Use the document-type lists below as prompts, not required sections.

For a document that instructs agents, call the Skill tool with "writing-for-agents" and apply its guidance alongside this skill.

Document types

README

• What this is and why it exists
• Quick start that reaches a first success in under five minutes
• Configuration and usage
• Contributing guidance

API reference