Guidance on using tools for documentation extraction.
codebase_search
Initial code discovery.
Find feature entry points
authentication login user session JWT token
]]>
Find business logic
calculate pricing discount tax invoice billing
]]>
Find configuration
config settings environment variables .env process.env
]]>
list_code_definition_names
Understand code structure.
Use on core feature directories.
Analyze implementation and test directories.
Look for naming patterns.
src/features/authentication
]]>
read_file
Analyze specific implementations.
Read main feature files.
Follow imports to find dependencies.
Read test files for expected behavior.
Examine config and type definition files.
src/controllers/auth.controller.ts
src/services/auth.service.ts
src/models/user.model.ts
src/types/auth.types.ts
src/__tests__/auth.test.ts
]]>
search_files
Find specific patterns.
Find API endpoints
src
@(Get|Post|Put|Delete|Patch)\(['"]([^'"]+)['"]|router\.(get|post|put|delete|patch)\(['"]([^'"]+)['"]
]]>
Find error handling
src
throw new \w+Error|catch \(|\.catch\(|try \{
]]>
Find config usage
src
process\.env\.\w+|config\.get\(['"]([^'"]+)['"]|getConfig\(\)
]]>
Create documentation file for new docs.
Not used for reviews. Feedback for reviews is provided in chat.
DOCS-TEMP-[feature-name].md
Use descriptive feature name in filename.
Include table of contents.
Use consistent Markdown formatting.
Include syntax-highlighted code examples.
DOCS-TEMP-authentication-system.md
# Authentication System Documentation
## Table of Contents
1. [Overview](#overview)
2. [Architecture](#architecture)
...
## Overview
The authentication system provides secure user authentication using JWT tokens...
...
]]>
Clarify ambiguous requirements.
Multiple features have similar names.
Documentation depth is unclear.
Audience priorities are undefined.
Which authentication aspects should be the focus?
The complete flow (JWT, sessions, OAuth).
Only JWT implementation and validation.
Only OAuth2 integration.
Password reset and recovery workflows.
]]>
What level of technical detail is needed?
High-level overview for all audiences.
Detailed developer implementation.
API reference with code examples.
Full coverage for all audiences.
]]>
Find all files related to a feature.
Start with semantic search.
feature implementation main logic
]]>
List directory structure.
src/features
true
]]>
Find related tests.
src
describe\(['"].*Feature.*['"]|test\(['"].*feature.*['"]
*.test.ts
]]>
Find config files.
.
feature.*config|settings.*feature
*.json
]]>
Follow import chains to map dependencies.
Read main file.
Extract all imports.
Read each imported file.
Recursively analyze imports.
Build dependency graph.
src/feature
import\s+(?:{[^}]+}|\*\s+as\s+\w+|\w+)\s+from\s+['"]([^'"]+)['"]
src/feature
require\(['"]([^'"]+)['"]\)
]]>
Extract API documentation from code.
Route definitions, request/response schemas, auth requirements, rate limiting, error responses.
Find route files.
Extract route definitions.
Find controllers.
Analyze request validation.
Document response formats.
Use tests to document expected behavior.
Tests provide usage examples.
Test descriptions explain functionality.
Tests cover edge cases.
Tests document expected outputs.
__tests__
(describe|it|test)\(['"]([^'"]+)['"]
__tests__/feature.test.ts
]]>
.env.example
config/*.json
src/config/*
README.md (configuration section)
Custom error classes
Error code constants
Error message templates
HTTP status codes
src
class\s+\w*Error\s+extends|new Error\(|throw new|ERROR_CODE|HTTP_STATUS
]]>
Authentication methods
Authorization rules
Data encryption
Input validation
Rate limiting
src
@Authorized|requireAuth|checkPermission|encrypt|decrypt|sanitize|validate|rateLimit
]]>
Organize output for navigation.
- Clear hierarchy, consistent headings, ToC with links, cross-references.
Include relevant code examples.
- Use syntax highlighting, show request/response, include error cases.
Suggest diagrams where helpful.
- Architecture, sequence, data flow, state machine diagrams.
Include important metadata.
- Version compatibility, last updated, status, performance, security.