read-docs-first
Review documentation before executing commands to understand system architecture and available tools.
Overview
When working with unfamiliar codebases or systems, reading documentation first saves time and prevents mistakes. It helps you understand the architecture, discover available tools, and use them correctly.
Steps
- Locate documentation files - Look for README.md, ARCHITECTURE.md, docs/ folders, or inline comments in entry points
- Read architecture overview - Understand the system's structure, main components, and how they interact
- Scan for available tools - Look for CLI commands, scripts, utility functions, or built-in helpers
- Review configuration - Check for config files, environment setup, or initialization requirements
- Note key patterns - Identify coding conventions, naming schemes, or standard workflows used in the project
- Execute with confidence - Now run commands or write code with full context of how the system works
Tips
- Start with the topmost README or documentation index
- Pay special attention to "Getting Started" or "Quick Start" sections
- Look for diagrams or architecture visualizations
- Check the CLI help output (
--help, -h) for command descriptions
- Bookmark or reference key documentation URLs for quick access during development
1---2name: read-docs-first3description: read-docs-first4---5# read-docs-first67Review documentation before executing commands to understand system architecture and available tools.89## Overview10When working with unfamiliar codebases or systems, reading documentation first saves time and prevents mistakes. It helps you understand the architecture, discover available tools, and use them correctly.1112## Steps131. **Locate documentation files** - Look for README.md, ARCHITECTURE.md, docs/ folders, or inline comments in entry points142. **Read architecture overview** - Understand the system's structure, main components, and how they interact153. **Scan for available tools** - Look for CLI commands, scripts, utility functions, or built-in helpers164. **Review configuration** - Check for config files, environment setup, or initialization requirements175. **Note key patterns** - Identify coding conventions, naming schemes, or standard workflows used in the project186. **Execute with confidence** - Now run commands or write code with full context of how the system works1920## Tips21- Start with the topmost README or documentation index22- Pay special attention to "Getting Started" or "Quick Start" sections23- Look for diagrams or architecture visualizations24- Check the CLI help output (`--help`, `-h`) for command descriptions25- Bookmark or reference key documentation URLs for quick access during development
claudiawong522