documentation

This skill acts as a dedicated technical writer, enabling Claude to generate, organize, and maintain high-quality engineering documentation. It is designed for software developers, system architects, and technical leads who need to convert complex system behaviors or operational requirements into readable, actionable formats. By following established documentation standards, the skill ensures that technical knowledge is shared effectively across the team, reducing onboarding time and maintenance overhead.

• Automatically generate README files including project purpose, configuration steps, and contribution guidelines.

• Construct comprehensive API documentation with endpoint references, authentication details, rate limits, and request/response examples.

• Develop operational runbooks that outline prerequisites, step-by-step procedures, rollback steps, and escalation paths for incident response.

• Create architecture decision records (ADRs) that document high-level design, trade-offs, data flow, and integration points.

• Produce onboarding guides detailing environment setup, system maps, and common workflow walkthroughs for new team members.

• Enforce documentation principles such as writing for the target reader, prioritizing the most critical information, using clear examples, and maintaining a single source of truth.

• Provide context or code snippets as input to generate accurate, relevant drafts; the skill excels at turning raw development data into polished prose.

• Always prioritize showing over telling—include terminal commands, SDK usage, and system diagrams where appropriate.

• Ensure documentation remains current by periodically auditing existing files against your actual codebase or infrastructure.

• Use cross-referencing and linking rather than duplicating content to keep maintenance effort low and accuracy high.

• Suitable for various formats including Markdown, OpenAPI specifications, or internal wiki pages.

• Constraints: The skill works best when supplied with specific technical context or source files; ensure that sensitive data like API keys or internal credentials are redacted before sharing content for documentation processing.