mirror of
https://github.com/RooVetGit/Roo-Code.git
synced 2026-08-28 05:27:24 +00:00
2ecf2ce5ad
- Enhanced extraction workflow with clearer step-by-step instructions - Improved documentation patterns for better structure recognition - Refined analysis techniques for comprehensive coverage - Updated tool usage guide with practical examples - Added complete extraction examples for common scenarios - Improved communication guidelines for clearer output - Enhanced user-friendly examples with better formatting
380 lines
No EOL
11 KiB
XML
380 lines
No EOL
11 KiB
XML
<tool_usage_guide>
|
|
<overview>
|
|
Guidance on using tools for documentation extraction.
|
|
</overview>
|
|
|
|
<tool_sequence>
|
|
<priority level="1">
|
|
<tool>codebase_search</tool>
|
|
<purpose>Initial code discovery.</purpose>
|
|
<usage_patterns>
|
|
<pattern>
|
|
<scenario>Find feature entry points</scenario>
|
|
<example><![CDATA[
|
|
<codebase_search>
|
|
<query>authentication login user session JWT token</query>
|
|
</codebase_search>
|
|
]]></example>
|
|
</pattern>
|
|
<pattern>
|
|
<scenario>Find business logic</scenario>
|
|
<example><![CDATA[
|
|
<codebase_search>
|
|
<query>calculate pricing discount tax invoice billing</query>
|
|
</codebase_search>
|
|
]]></example>
|
|
</pattern>
|
|
<pattern>
|
|
<scenario>Find configuration</scenario>
|
|
<example><![CDATA[
|
|
<codebase_search>
|
|
<query>config settings environment variables .env process.env</query>
|
|
</codebase_search>
|
|
]]></example>
|
|
</pattern>
|
|
</usage_patterns>
|
|
</priority>
|
|
|
|
<priority level="2">
|
|
<tool>list_code_definition_names</tool>
|
|
<purpose>Understand code structure.</purpose>
|
|
<best_practices>
|
|
<practice>Use on core feature directories.</practice>
|
|
<practice>Analyze implementation and test directories.</practice>
|
|
<practice>Look for naming patterns.</practice>
|
|
</best_practices>
|
|
<example><![CDATA[
|
|
<list_code_definition_names>
|
|
<path>src/features/authentication</path>
|
|
</list_code_definition_names>
|
|
]]></example>
|
|
</priority>
|
|
|
|
<priority level="3">
|
|
<tool>read_file</tool>
|
|
<purpose>Analyze specific implementations.</purpose>
|
|
<strategy>
|
|
<step>Read main feature files.</step>
|
|
<step>Follow imports to find dependencies.</step>
|
|
<step>Read test files for expected behavior.</step>
|
|
<step>Examine config and type definition files.</step>
|
|
</strategy>
|
|
<batch_reading><![CDATA[
|
|
<read_file>
|
|
<args>
|
|
<file>
|
|
<path>src/controllers/auth.controller.ts</path>
|
|
</file>
|
|
<file>
|
|
<path>src/services/auth.service.ts</path>
|
|
</file>
|
|
<file>
|
|
<path>src/models/user.model.ts</path>
|
|
</file>
|
|
<file>
|
|
<path>src/types/auth.types.ts</path>
|
|
</file>
|
|
<file>
|
|
<path>src/__tests__/auth.test.ts</path>
|
|
</file>
|
|
</args>
|
|
</read_file>
|
|
]]></batch_reading>
|
|
</priority>
|
|
|
|
<priority level="4">
|
|
<tool>search_files</tool>
|
|
<purpose>Find specific patterns.</purpose>
|
|
<use_cases>
|
|
<use_case>
|
|
<description>Find API endpoints</description>
|
|
<example><![CDATA[
|
|
<search_files>
|
|
<path>src</path>
|
|
<regex>@(Get|Post|Put|Delete|Patch)\(['"]([^'"]+)['"]|router\.(get|post|put|delete|patch)\(['"]([^'"]+)['"]</regex>
|
|
</search_files>
|
|
]]></example>
|
|
</use_case>
|
|
<use_case>
|
|
<description>Find error handling</description>
|
|
<example><![CDATA[
|
|
<search_files>
|
|
<path>src</path>
|
|
<regex>throw new \w+Error|catch \(|\.catch\(|try \{</regex>
|
|
</search_files>
|
|
]]></example>
|
|
</use_case>
|
|
<use_case>
|
|
<description>Find config usage</description>
|
|
<example><![CDATA[
|
|
<search_files>
|
|
<path>src</path>
|
|
<regex>process\.env\.\w+|config\.get\(['"]([^'"]+)['"]|getConfig\(\)</regex>
|
|
</search_files>
|
|
]]></example>
|
|
</use_case>
|
|
</use_cases>
|
|
</priority>
|
|
</tool_sequence>
|
|
|
|
<documentation_generation_tools>
|
|
<tool name="write_to_file">
|
|
<purpose>Create documentation file for new docs.</purpose>
|
|
<note>Not used for reviews. Feedback for reviews is provided in chat.</note>
|
|
<file_naming>DOCS-TEMP-[feature-name].md</file_naming>
|
|
<best_practices>
|
|
<practice>Use descriptive feature name in filename.</practice>
|
|
<practice>Include table of contents.</practice>
|
|
<practice>Use consistent Markdown formatting.</practice>
|
|
<practice>Include syntax-highlighted code examples.</practice>
|
|
</best_practices>
|
|
<example><
|
|
2. [Architecture](#architecture)
|
|
...
|
|
|
|
## Overview
|
|
The authentication system provides secure user authentication using JWT tokens...
|
|
</content>
|
|
<line_count>...</line_count>
|
|
</write_to_file>
|
|
]]></example>
|
|
</tool>
|
|
|
|
<tool name="ask_followup_question">
|
|
<purpose>Clarify ambiguous requirements.</purpose>
|
|
<when_to_use>
|
|
<scenario>Multiple features have similar names.</scenario>
|
|
<scenario>Documentation depth is unclear.</scenario>
|
|
<scenario>Audience priorities are undefined.</scenario>
|
|
</when_to_use>
|
|
<examples>
|
|
<example><![CDATA[
|
|
<ask_followup_question>
|
|
<question>Which authentication aspects should be the focus?</question>
|
|
<follow_up>
|
|
<suggest>The complete flow (JWT, sessions, OAuth).</suggest>
|
|
<suggest>Only JWT implementation and validation.</suggest>
|
|
<suggest>Only OAuth2 integration.</suggest>
|
|
<suggest>Password reset and recovery workflows.</suggest>
|
|
</follow_up>
|
|
</ask_followup_question>
|
|
]]></example>
|
|
<example><![CDATA[
|
|
<ask_followup_question>
|
|
<question>What level of technical detail is needed?</question>
|
|
<follow_up>
|
|
<suggest>High-level overview for all audiences.</suggest>
|
|
<suggest>Detailed developer implementation.</suggest>
|
|
<suggest>API reference with code examples.</suggest>
|
|
<suggest>Full coverage for all audiences.</suggest>
|
|
</follow_up>
|
|
</ask_followup_question>
|
|
]]></example>
|
|
</examples>
|
|
</tool>
|
|
</documentation_generation_tools>
|
|
|
|
<analysis_strategies>
|
|
<strategy name="file_discovery">
|
|
<description>
|
|
Find all files related to a feature.
|
|
</description>
|
|
<steps>
|
|
<step>
|
|
<action>Start with semantic search.</action>
|
|
<tool_use><![CDATA[
|
|
<codebase_search>
|
|
<query>feature implementation main logic</query>
|
|
</codebase_search>
|
|
]]></tool_use>
|
|
</step>
|
|
<step>
|
|
<action>List directory structure.</action>
|
|
<tool_use><![CDATA[
|
|
<list_files>
|
|
<path>src/features</path>
|
|
<recursive>true</recursive>
|
|
</list_files>
|
|
]]></tool_use>
|
|
</step>
|
|
<step>
|
|
<action>Find related tests.</action>
|
|
<tool_use><![CDATA[
|
|
<search_files>
|
|
<path>src</path>
|
|
<regex>describe\(['"].*Feature.*['"]|test\(['"].*feature.*['"]</regex>
|
|
<file_pattern>*.test.ts</file_pattern>
|
|
</search_files>
|
|
]]></tool_use>
|
|
</step>
|
|
<step>
|
|
<action>Find config files.</action>
|
|
<tool_use><![CDATA[
|
|
<search_files>
|
|
<path>.</path>
|
|
<regex>feature.*config|settings.*feature</regex>
|
|
<file_pattern>*.json</file_pattern>
|
|
</search_files>
|
|
]]></tool_use>
|
|
</step>
|
|
</steps>
|
|
</strategy>
|
|
|
|
<strategy name="dependency_chain_analysis">
|
|
<description>
|
|
Follow import chains to map dependencies.
|
|
</description>
|
|
<process>
|
|
<step>Read main file.</step>
|
|
<step>Extract all imports.</step>
|
|
<step>Read each imported file.</step>
|
|
<step>Recursively analyze imports.</step>
|
|
<step>Build dependency graph.</step>
|
|
</process>
|
|
<import_patterns><![CDATA[
|
|
<!-- TypeScript/JavaScript imports -->
|
|
<search_files>
|
|
<path>src/feature</path>
|
|
<regex>import\s+(?:{[^}]+}|\*\s+as\s+\w+|\w+)\s+from\s+['"]([^'"]+)['"]</regex>
|
|
</search_files>
|
|
|
|
<!-- CommonJS requires -->
|
|
<search_files>
|
|
<path>src/feature</path>
|
|
<regex>require\(['"]([^'"]+)['"]\)</regex>
|
|
</search_files>
|
|
]]></import_patterns>
|
|
</strategy>
|
|
|
|
<strategy name="api_documentation_extraction">
|
|
<description>
|
|
Extract API documentation from code.
|
|
</description>
|
|
<extraction_points>
|
|
<point>Route definitions, request/response schemas, auth requirements, rate limiting, error responses.</point>
|
|
</extraction_points>
|
|
<tools_sequence>
|
|
<sequence>
|
|
<step>Find route files.</step>
|
|
<step>Extract route definitions.</step>
|
|
<step>Find controllers.</step>
|
|
<step>Analyze request validation.</step>
|
|
<step>Document response formats.</step>
|
|
</sequence>
|
|
</tools_sequence>
|
|
</strategy>
|
|
|
|
<strategy name="test_driven_documentation">
|
|
<description>
|
|
Use tests to document expected behavior.
|
|
</description>
|
|
<benefits>
|
|
<benefit>Tests provide usage examples.</benefit>
|
|
<benefit>Test descriptions explain functionality.</benefit>
|
|
<benefit>Tests cover edge cases.</benefit>
|
|
<benefit>Tests document expected outputs.</benefit>
|
|
</benefits>
|
|
<extraction_approach><![CDATA[
|
|
<!-- Find test descriptions -->
|
|
<search_files>
|
|
<path>__tests__</path>
|
|
<regex>(describe|it|test)\(['"]([^'"]+)['"]</regex>
|
|
</search_files>
|
|
|
|
<!-- Extract test scenarios -->
|
|
<read_file>
|
|
<path>__tests__/feature.test.ts</path>
|
|
</read_file>
|
|
]]></extraction_approach>
|
|
</strategy>
|
|
</analysis_strategies>
|
|
|
|
<common_patterns>
|
|
<pattern name="configuration_documentation">
|
|
<search_locations>
|
|
<location>.env.example</location>
|
|
<location>config/*.json</location>
|
|
<location>src/config/*</location>
|
|
<location>README.md (configuration section)</location>
|
|
</search_locations>
|
|
<extraction_regex><![CDATA[
|
|
# Environment variables
|
|
process\.env\.(\w+)
|
|
|
|
# Config object access
|
|
config\.(\w+)\.(\w+)
|
|
|
|
# Default values
|
|
\w+\s*=\s*process\.env\.\w+\s*\|\|\s*['"]([^'"]+)['"]
|
|
]]></extraction_regex>
|
|
</pattern>
|
|
|
|
<pattern name="error_documentation">
|
|
<error_patterns>
|
|
<pattern>Custom error classes</pattern>
|
|
<pattern>Error code constants</pattern>
|
|
<pattern>Error message templates</pattern>
|
|
<pattern>HTTP status codes</pattern>
|
|
</error_patterns>
|
|
<search_approach><![CDATA[
|
|
<search_files>
|
|
<path>src</path>
|
|
<regex>class\s+\w*Error\s+extends|new Error\(|throw new|ERROR_CODE|HTTP_STATUS</regex>
|
|
</search_files>
|
|
]]></search_approach>
|
|
</pattern>
|
|
|
|
<pattern name="security_documentation">
|
|
<security_aspects>
|
|
<aspect>Authentication methods</aspect>
|
|
<aspect>Authorization rules</aspect>
|
|
<aspect>Data encryption</aspect>
|
|
<aspect>Input validation</aspect>
|
|
<aspect>Rate limiting</aspect>
|
|
</security_aspects>
|
|
<indicators><![CDATA[
|
|
<search_files>
|
|
<path>src</path>
|
|
<regex>@Authorized|requireAuth|checkPermission|encrypt|decrypt|sanitize|validate|rateLimit</regex>
|
|
</search_files>
|
|
]]></indicators>
|
|
</pattern>
|
|
</common_patterns>
|
|
|
|
<output_optimization>
|
|
<guideline name="structure">
|
|
<description>Organize output for navigation.</description>
|
|
<structure>
|
|
- Clear hierarchy, consistent headings, ToC with links, cross-references.
|
|
</structure>
|
|
</guideline>
|
|
|
|
<guideline name="code_examples">
|
|
<description>Include relevant code examples.</description>
|
|
<best_practices>
|
|
- Use syntax highlighting, show request/response, include error cases.
|
|
</best_practices>
|
|
</guideline>
|
|
|
|
<guideline name="visuals">
|
|
<description>Suggest diagrams where helpful.</description>
|
|
<diagram_types>
|
|
- Architecture, sequence, data flow, state machine diagrams.
|
|
</diagram_types>
|
|
</guideline>
|
|
|
|
<guideline name="metadata">
|
|
<description>Include important metadata.</description>
|
|
<required_metadata>
|
|
- Version compatibility, last updated, status, performance, security.
|
|
</required_metadata>
|
|
</guideline>
|
|
</output_optimization>
|
|
</tool_usage_guide> |