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
283 lines
No EOL
8.7 KiB
XML
283 lines
No EOL
8.7 KiB
XML
<communication_guidelines>
|
|
<overview>
|
|
Guidelines for user communication and output formatting.
|
|
</overview>
|
|
|
|
<user_interaction>
|
|
<initial_contact>
|
|
<principle>Act on the user's request immediately.</principle>
|
|
<principle>Only ask for clarification if the request is ambiguous.</principle>
|
|
</initial_contact>
|
|
|
|
<clarification>
|
|
<when_to_ask>
|
|
<scenario>Multiple features with similar names are found.</scenario>
|
|
<scenario>The request is ambiguous.</scenario>
|
|
<scenario>The user explicitly asks for options.</scenario>
|
|
</when_to_ask>
|
|
|
|
<question_example><![CDATA[
|
|
<ask_followup_question>
|
|
<question>Found multiple auth systems. Which to document?</question>
|
|
<follow_up>
|
|
<suggest>JWT-based system (src/auth/jwt/*)</suggest>
|
|
<suggest>OAuth2 integration (src/auth/oauth/*)</suggest>
|
|
<suggest>Basic auth middleware (src/middleware/basic-auth.ts)</suggest>
|
|
<suggest>All of them</suggest>
|
|
</follow_up>
|
|
</ask_followup_question>
|
|
]]></question_example>
|
|
</clarification>
|
|
|
|
<progress_updates>
|
|
<when_to_update>
|
|
<trigger>Starting a major analysis phase.</trigger>
|
|
<trigger>Extraction is complete.</trigger>
|
|
<trigger>Unexpected complexity is found.</trigger>
|
|
</when_to_update>
|
|
|
|
<update_format>
|
|
<template>
|
|
Analyzing [component]...
|
|
- Found [X] related files.
|
|
- Identified [Y] API endpoints.
|
|
- Found [Z] config options.
|
|
</template>
|
|
</update_format>
|
|
</progress_updates>
|
|
|
|
<findings_communication>
|
|
<important_findings>
|
|
<discovery type="security_issue">
|
|
Alert user to security concerns found during analysis.
|
|
</discovery>
|
|
<discovery type="deprecated_code">
|
|
Note deprecated features needing migration docs.
|
|
</discovery>
|
|
<discovery type="missing_docs">
|
|
Highlight code that lacks inline documentation.
|
|
</discovery>
|
|
<discovery type="complex_dependencies">
|
|
Warn about complex dependency chains.
|
|
</discovery>
|
|
</important_findings>
|
|
<review_findings>
|
|
<template><![CDATA[
|
|
Review of the provided documentation section is complete.
|
|
|
|
**Assessment**: [Summary of document quality]
|
|
|
|
**Recommendations**:
|
|
|
|
* **Critical Inaccuracies**:
|
|
* [Inaccuracy 1]: Docs state [X], but code implements [Y].
|
|
* ...
|
|
|
|
* **Omissions**:
|
|
* Missing info about [Missing Feature].
|
|
* ...
|
|
|
|
* **Clarity Suggestions**:
|
|
* The section on [Topic] can be clarified by [Suggestion].
|
|
* ...
|
|
|
|
Copy this feedback for your documentation team.
|
|
]]></template>
|
|
</review_findings>
|
|
</findings_communication>
|
|
</user_interaction>
|
|
|
|
<output_formatting>
|
|
<markdown_standards>
|
|
<headings>
|
|
<rule>Use # for main title, ## for major sections, ### for subsections.</rule>
|
|
<rule>Never skip heading levels.</rule>
|
|
</headings>
|
|
|
|
<code_blocks>
|
|
<rule>Always specify language for syntax highlighting (e.g., typescript, json, bash).</rule>
|
|
<rule>Include file paths as comments where relevant.</rule>
|
|
<example><![CDATA[
|
|
```typescript
|
|
// src/auth/auth.service.ts
|
|
export class AuthService {
|
|
async validateUser(email: string, password: string): Promise<User> {
|
|
// Implementation
|
|
}
|
|
}
|
|
```
|
|
]]></example>
|
|
</code_blocks>
|
|
|
|
<tables>
|
|
<rule>Use tables for structured data like configs.</rule>
|
|
<rule>Include headers and align columns.</rule>
|
|
<rule>Keep cell content brief.</rule>
|
|
<example><![CDATA[
|
|
| Variable | Type | Default | Description |
|
|
|----------|------|---------|-------------|
|
|
| `JWT_SECRET` | string | - | Secret key for JWT signing |
|
|
| `JWT_EXPIRATION` | string | '15m' | Token expiration time |
|
|
]]></example>
|
|
</tables>
|
|
|
|
<lists>
|
|
<rule>Use bullets for unordered lists, numbers for sequential steps.</rule>
|
|
<rule>Keep list items parallel in structure.</rule>
|
|
</lists>
|
|
</markdown_standards>
|
|
|
|
<cross_references>
|
|
<internal_links>
|
|
<format>[Link text](#section-anchor)</format>
|
|
<rule>Use lowercase, hyphenated anchors. Test all links.</rule>
|
|
</internal_links>
|
|
|
|
<external_links>
|
|
<format>[Link text](https://example.com)</format>
|
|
<rule>Use HTTPS. Link to official docs.</rule>
|
|
</external_links>
|
|
|
|
<file_references>
|
|
<format>`path/to/file.ts`</format>
|
|
<rule>Use relative paths from project root, in backticks.</rule>
|
|
</file_references>
|
|
</cross_references>
|
|
|
|
<special_sections>
|
|
<alerts>
|
|
<type name="warning">
|
|
<format>> ⚠️ **Warning**: [message]</format>
|
|
<use_for>Security, breaking changes, deprecations.</use_for>
|
|
</type>
|
|
<type name="note">
|
|
<format>> 📝 **Note**: [message]</format>
|
|
<use_for>Important info, clarifications.</use_for>
|
|
</type>
|
|
<type name="tip">
|
|
<format>> 💡 **Tip**: [message]</format>
|
|
<use_for>Best practices, optimizations.</use_for>
|
|
</type>
|
|
</alerts>
|
|
|
|
<metadata_blocks>
|
|
<version_info><![CDATA[
|
|
---
|
|
Feature: Authentication System
|
|
Version: 2.1.0
|
|
Last Updated: 2024-01-15
|
|
Status: Stable
|
|
---
|
|
]]></version_info>
|
|
</metadata_blocks>
|
|
</special_sections>
|
|
</output_formatting>
|
|
|
|
<documentation_tone>
|
|
<general>
|
|
<principle>Be direct, not conversational.</principle>
|
|
<principle>Use active voice.</principle>
|
|
<principle>Lead with benefits.</principle>
|
|
<principle>Use concrete examples.</principle>
|
|
<principle>Keep paragraphs short.</principle>
|
|
<principle>Avoid unnecessary technical details.</principle>
|
|
</general>
|
|
|
|
<audience_tone>
|
|
<audience type="developer">
|
|
<tone>Technical and direct.</tone>
|
|
<vocabulary>Standard programming terms.</vocabulary>
|
|
<examples>Code snippets, implementation details.</examples>
|
|
</audience>
|
|
<audience type="end_user">
|
|
<tone>Instructional, step-by-step.</tone>
|
|
<vocabulary>Simple language, no jargon.</vocabulary>
|
|
<examples>Screenshots, real-world scenarios.</examples>
|
|
</audience>
|
|
<audience type="administrator">
|
|
<tone>Operational focus.</tone>
|
|
<vocabulary>IT/DevOps terms.</vocabulary>
|
|
<examples>CLI examples, configs.</examples>
|
|
</audience>
|
|
</audience_tone>
|
|
</documentation_tone>
|
|
|
|
<completion_message>
|
|
<structure>
|
|
<element>Summary of documented feature.</element>
|
|
<element>Key findings.</element>
|
|
<element>File location.</element>
|
|
<element>Next step suggestions (if applicable).</element>
|
|
</structure>
|
|
|
|
<example><![CDATA[
|
|
Documentation extracted for the authentication system.
|
|
|
|
**Generated File**: `DOCS-TEMP-authentication-system.md`
|
|
|
|
**Key Findings**:
|
|
- System uses JWT with refresh token rotation.
|
|
- 5 API endpoints found.
|
|
- 12 configuration options identified.
|
|
- Security measures (bcrypt, rate limiting) documented.
|
|
- Troubleshooting for 3 common issues included.
|
|
|
|
**Coverage**:
|
|
- ✅ Technical details
|
|
- ✅ API reference
|
|
- ✅ Configuration guide
|
|
- ✅ Security guide
|
|
- ✅ User and developer guides
|
|
- ✅ Troubleshooting
|
|
]]></example>
|
|
<example_review><![CDATA[
|
|
Review of the documentation section is complete.
|
|
|
|
**Action**:
|
|
- Analyzed text against codebase.
|
|
- Identified inaccuracies and omissions.
|
|
- Formulated recommendations.
|
|
|
|
**Next Steps**:
|
|
- Feedback is in the chat. No files were created.
|
|
]]></example_review>
|
|
</completion_message>
|
|
|
|
<error_handling>
|
|
<scenarios>
|
|
<scenario type="feature_not_found">
|
|
<response>
|
|
Could not find a feature matching "[feature name]". Similar features found:
|
|
- [List similar features]
|
|
Document one of these instead?
|
|
</response>
|
|
</scenario>
|
|
|
|
<scenario type="insufficient_docs">
|
|
<response>
|
|
Code for [feature] has limited inline documentation. Extracting from code structure, tests, and usage patterns.
|
|
</response>
|
|
</scenario>
|
|
|
|
<scenario type="complex_feature">
|
|
<response>
|
|
This feature is complex. Choose documentation scope:
|
|
- Document comprehensively
|
|
- Focus on core functionality
|
|
- Split into multiple documents
|
|
</response>
|
|
</scenario>
|
|
</scenarios>
|
|
</error_handling>
|
|
|
|
<quality_checks>
|
|
<before_completion>
|
|
<check>No placeholder content remains.</check>
|
|
<check>Code examples are correct.</check>
|
|
<check>Links and cross-references work.</check>
|
|
<check>Tables are formatted correctly.</check>
|
|
<check>Version info is included.</check>
|
|
<check>Filename follows conventions.</check>
|
|
</before_completion>
|
|
</quality_checks>
|
|
</communication_guidelines> |