writing-design-docs

What problem does it solve?

This Skill ensures that features and systems are well-documented, making them easier to understand, maintain, and scale by preventing knowledge silos and ensuring documentation stays in sync with code changes.

Core Features & Use Cases

• Standardized Documentation: Creates design docs using the Purpose/Behavior/Verify structure for features and architecture.
• Documentation Sync: Enforces updating documentation in the same PR as related code changes.
• Use Case: When you implement a new user authentication flow, this Skill helps you write a clear design doc detailing its purpose, expected behavior, and verification steps, ensuring the documentation is updated alongside the code.

Quick Start

Write a design doc for the new user authentication flow.