documentation
Documentation Skill
Create clear, useful documentation that helps people understand and use your code.
Core Principle
Write for the reader, not for yourself.
Types of Documentation
1. README Files
Purpose: Help users understand what the project does and how to use it
Audience: New users, potential contributors
Key sections:
- What it does (one paragraph)
More from thebushidocollective/han
android-jetpack-compose
Use when building Android UIs with Jetpack Compose, managing state with remember/mutableStateOf, or implementing declarative UI patterns.
1.1Kfastapi-async-patterns
Use when FastAPI async patterns for building high-performance APIs. Use when handling concurrent requests and async operations.
785storybook-story-writing
Use when creating or modifying Storybook stories for components. Ensures stories follow CSF3 format, properly showcase component variations, and build successfully.
486atomic-design-fundamentals
Use when applying Atomic Design methodology to organize UI components into quarks, atoms, molecules, organisms, templates, and pages. Core principles and hierarchy.
361solid-principles
Use during implementation when designing modules, functions, and components requiring SOLID principles for maintainable, flexible architecture.
246angular-rxjs-patterns
Use when handling async operations in Angular applications with observables, operators, and subjects.
216