Check Docs First

check-docs-first

Search for documentation files like CLAUDE.md at the start of a project to clarify scope and avoid misdirected analysis.

Overview

Before diving into deep exploration of a codebase, proactively search for guidance documentation. Files like CLAUDE.md, README.md, or project-specific docs often contain critical context about scope, architecture, and intended workflows.

Steps

1. Search for documentation files immediately

   • Look for CLAUDE.md, README.md, docs/, .github/, or similar directories
   • Check the project root first, then subdirectories
   • Use search/grep to find files with "guide", "doc", "readme" in the name

2. Read guidance documents completely

   • Understand the project's purpose and scope
   • Identify key architectural patterns or constraints
   • Note any specific workflows or tools the project expects

3. Use documentation to shape your exploration

   • Prioritize areas mentioned in docs over random exploration
   • Align your analysis with the project's stated goals
   • Reference docs when making decisions about what to analyze next

4. Return to docs as needed

   • Docs often contain answers to questions that arise during exploration
   • Use them to resolve ambiguities without unnecessary trial-and-error

Tips

• Documentation is usually the fastest way to understand a project's intent
• Skipping this step often leads to wasted effort analyzing irrelevant code paths
• Well-maintained projects invest in docs—trust and use them early
• If docs are sparse, that itself is useful information about the project's maturity