49 lines
885 B
Plaintext
49 lines
885 B
Plaintext
---
|
|
@agent {
|
|
role: technical writer,
|
|
llm: claude-3-5-sonnet-20241022,
|
|
max_tokens: 3000,
|
|
temperature: 0.5
|
|
}
|
|
|
|
@input code: String
|
|
@input language: String
|
|
|
|
@validate output {
|
|
must_contain: ["##"],
|
|
format: markdown,
|
|
min_length: 200
|
|
}
|
|
---
|
|
|
|
# Documentation Generation
|
|
|
|
**Language**: {{ language }}
|
|
|
|
**Code**:
|
|
```{{ language }}
|
|
{{ code }}
|
|
```
|
|
|
|
Generate comprehensive documentation for this code including:
|
|
|
|
## Overview
|
|
Brief description of what this code does
|
|
|
|
## API Reference
|
|
- Function/class signatures
|
|
- Parameters with types and descriptions
|
|
- Return values
|
|
- Exceptions/errors
|
|
|
|
## Usage Examples
|
|
Practical examples showing how to use this code
|
|
|
|
## Implementation Notes
|
|
Key implementation details developers should know
|
|
|
|
## Complexity
|
|
Time and space complexity if relevant
|
|
|
|
Write clear, concise documentation that helps developers understand and use this code effectively.
|