documentation

The documentation skill is designed to assist users in creating, maintaining, and organizing technical documentation across various formats. It addresses the challenge of producing clear, consistent, and accessible technical content, ensuring that information is understandable to different audiences and purposes. By streamlining the process of writing technical guides, the skill helps teams and individuals reduce miscommunication, improve knowledge transfer, and maintain up-to-date documentation that aligns with evolving systems and workflows.

This skill supports multiple types of documentation including README files, API references, operational runbooks, architecture documents, and onboarding guides. For each document type, it provides structured guidance: READMEs focus on quick start instructions, usage, configuration, and contribution; API documentation details endpoints, authentication, error handling, and SDK examples; runbooks outline procedures, prerequisites, rollback, and escalation paths; architecture documents capture context, design, decisions, and data flows; and onboarding guides cover environment setup, key systems, common tasks, and points of contact. It also follows principles such as writing for the reader, prioritizing useful information, including examples, keeping content current, and referencing other resources to avoid duplication.

The skill is particularly useful for software engineers, technical writers, system administrators, and teams responsible for knowledge management. It can be used when setting up new projects, explaining APIs, documenting operational procedures, onboarding new team members, or maintaining organizational knowledge. The skill ensures that technical content is clear, actionable, and maintainable, making it easier for teams to collaborate and for new members to get up to speed efficiently.