documentation-writing
Documentation Writing
This skill covers best practices for creating effective documentation that developers actually want to read and maintain.
Core Philosophy
Great documentation is:
- Clear: Easy to understand on first reading
- Complete: Answers the questions users actually have
- Current: Kept in sync with code changes
- Concise: No unnecessary fluff
- Scannable: Easy to find what you need
- Practical: Focuses on how-to, not just what
Types of Documentation
1. README Files
The front door to your project:
More from tejovanthn/rasikalife
sst-dev
Best practices, patterns, and conventions for working with SST.dev (Serverless Stack) for AWS infrastructure
21conform
Progressive enhancement form validation with Conform and Zod for Remix applications - type-safe forms that work without JavaScript
18marketing-copy
Proven copywriting frameworks and best practices for creating compelling marketing content across different channels
18email-templates
Transactional email design using React Email and integration with email providers like Resend or AWS SES
15frontend-design
UI/UX design principles and patterns for building intuitive, accessible, and beautiful web interfaces
14electrodb
ElectroDB patterns for DynamoDB single-table design with full type safety and optimized access patterns
13