react-docs-writing
CommunityMaster documentation for React projects with clear, concise guidance.
Authorjaballer
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill provides a comprehensive guide to writing effective documentation for React projects, ensuring clarity, accessibility, and understanding of the design decisions.
Core Features & Use Cases
- README Structure: Offers a template for README files that cover Overview, Decisions, Tradeoffs, How to Run, and What's Next.
- In-Code Comments: Guidelines for writing "why" comments that explain design decisions.
- DESIGN.md: Best practices for structuring documentation for larger projects.
- PR Writeups: Format for writing clear and concise pull request descriptions.
Quick Start
To generate a README for your React project, use the react-docs-writing skill with the command: /react-docs-writing create-readme
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: react-docs-writing Download link: https://github.com/jaballer/react-claude-skills/archive/main.zip#react-docs-writing Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 620,000+ vetted skills library on demand.