This skill transforms technical documentation from a dry list of APIs into a narrative-driven guide focused on solving actual user problems. It ensures that complex concepts are defined before use, code examples are safe for production, and every section provides a clear path forward for the reader. By applying structured readability rules and industry best practices, it helps developers create documentation that is accessible to humans while maintaining high technical standards for migrations, installations, and core architectural concepts.
주요 기능
01Structures content around user problems rather than API signatures
02Ensures all technical concepts are grounded in the user mental model
03Identifies and fixes cold or abrupt section openings
04Provides standardized templates for migration and troubleshooting guides
05Validates code examples for state ownership and production safety
066,343 GitHub stars
사용 사례
01Auditing existing guides to identify missing definitions or unsafe code patterns
02Creating new documentation sections that follow a consistent logical flow
03Refactoring API-heavy documentation to be more user-centric and readable