Documentation Writing Guidelines

What problem does it solve?

This Skill provides a structured approach to documentation, preventing information overload and ensuring consistency. It solves the problem of developers struggling to write clear, maintainable, and AI-friendly documentation, ultimately saving time in context management and review cycles.

Core Features & Use Cases

• 500-Line Rule: Enforces concise documentation for faster AI processing and improved human readability.
• Progressive Disclosure: Organizes information from high-level overviews to detailed specifics, preventing context loss.
• Show, Don't Just Tell: Emphasizes concrete code examples over abstract explanations to enhance understanding.
• Scannable Structure: Promotes the use of clear headings, lists, and formatting for easy navigation.
• Use Case: When documenting a new feature or updating a README, this skill ensures your documentation is structured, scannable, and adheres to best practices, making it easy for both humans and AI to understand and utilize.

Quick Start

Use the documentation-writing skill to help me write a SKILL.md for my new backend-api skill, ensuring it follows the 500-line rule and progressive disclosure.