Guidelines for user communication and output formatting.
Act on the user's request immediately.
Only ask for clarification if the request is ambiguous.
Multiple features with similar names are found.
The request is ambiguous.
The user explicitly asks for options.
Starting a major analysis phase.
Extraction is complete.
Unexpected complexity is found.
Analyzing [component]...
- Found [X] related files.
- Identified [Y] API endpoints.
- Found [Z] config options.
Alert user to security concerns found during analysis.
Note deprecated features needing migration docs.
Highlight code that lacks inline documentation.
Warn about complex dependency chains.
Feature extraction complete for [feature name].
**Extraction Report**: `EXTRACTION-[feature].md`
**Key Findings**:
- Technical Components: [X] classes, [Y] APIs, [Z] configurations
- User Workflows: [number] primary use cases identified
- Business Logic: [summary of core functionality]
- Integration Points: [list of external dependencies]
**Documentation Considerations**:
- [Important aspect that needs clear explanation]
- [Complex area that may need diagrams]
- [Edge cases that should be documented]
The extraction report provides comprehensive details for your documentation team.
Documentation verification complete.
**Verification Report**: `VERIFICATION-[feature].md`
**Overall Assessment**: [Accurate/Needs Updates/Contains Critical Errors]
**Summary of Findings**:
- Critical Inaccuracies: [number]
- Technical Corrections Needed: [number]
- Missing Information: [number]
- Clarity Improvements: [number]
**Most Important Issues**:
1. [Critical issue that could mislead users]
2. [Important technical inaccuracy]
3. [Key missing information]
See the full verification report for detailed corrections and suggestions.
Use # for main title, ## for major sections, ### for subsections.
Never skip heading levels.
Always specify language for syntax highlighting (e.g., typescript, json, bash).
Include file paths as comments where relevant.
```typescript
// src/auth/auth.service.ts
export class AuthService {
async validateUser(email: string, password: string): Promise {
// Implementation
}
}
```
Use tables for structured data like configs.
Include headers and align columns.
Keep cell content brief.
| Variable | Type | Default | Description |
|----------|------|---------|-------------|
| `JWT_SECRET` | string | - | Secret key for JWT signing |
| `JWT_EXPIRATION` | string | '15m' | Token expiration time |
Use bullets for unordered lists, numbers for sequential steps.
Keep list items parallel in structure.
[Link text](#section-anchor)
Use lowercase, hyphenated anchors. Test all links.
[Link text](https://example.com)
Use HTTPS. Link to official docs.
`path/to/file.ts`
Use relative paths from project root, in backticks.
> ⚠️ **Warning**: [message]
Security, breaking changes, deprecations.
> 📝 **Note**: [message]
Important info, clarifications.
> 💡 **Tip**: [message]
Best practices, optimizations.
---
Feature: Authentication System
Version: 2.1.0
Last Updated: 2024-01-15
Status: Stable
---
Be direct, not conversational.
Use active voice.
Lead with benefits.
Use concrete examples.
Keep paragraphs short.
Avoid unnecessary technical details.
Technical and direct.
Standard programming terms.
Code snippets, implementation details.
Instructional, step-by-step.
Simple language, no jargon.
Screenshots, real-world scenarios.
Summary of analysis performed.
Key findings or issues identified.
Report file location.
Recommended next steps.
Feature extraction complete for the authentication system.
**Extraction Report**: `EXTRACTION-authentication-system.md`
**Technical Summary**:
- JWT-based authentication with refresh tokens
- 5 API endpoints (login, logout, refresh, register, profile)
- 12 configuration options
- bcrypt password hashing, rate limiting
**Non-Technical Summary**:
- Users can register, login, and manage sessions
- Supports "remember me" functionality
- Automatic session refresh for seamless experience
- Account lockout after failed attempts
**Documentation Considerations**:
- Token expiration times need clear explanation
- Password requirements should be prominently displayed
- Error messages need user-friendly translations
The extraction report contains all details needed for comprehensive documentation.
Documentation verification complete for the authentication system.
**Verification Report**: `VERIFICATION-authentication-system.md`
**Overall Assessment**: Needs Updates
**Critical Issues Found**:
1. JWT_SECRET documented as optional, but it's required
2. Token expiration listed as 30m, actual is 15m
3. Missing documentation for rate limiting feature
**Technical Corrections**: 7 items
**Missing Information**: 4 sections
**Clarity Improvements**: 3 suggestions
Please review the verification report for specific corrections needed.
Could not find a feature matching "[feature name]". Similar features found:
- [List similar features]
Document one of these instead?
Code for [feature] has limited inline documentation. Extracting from code structure, tests, and usage patterns.
This feature is complex. Choose documentation scope:
- Document comprehensively
- Focus on core functionality
- Split into multiple documents
No placeholder content remains.
Code examples are correct.
Links and cross-references work.
Tables are formatted correctly.
Version info is included.
Filename follows conventions.