Documentation Decorator¶

Creates comprehensive documentation for various audiences.

Category: Developer Workflow

Parameters¶

Parameter	Type	Description	Default
`for`	`enum`	Documentation target	`code`
`format`	`enum`	Documentation format	`markdown`
`detail`	`enum`	Documentation comprehensiveness	`standard`

For Options¶

code: Create code documentation that explains the implementation details, functions, classes, and methods.
api: Create API documentation that includes endpoints, request/response formats, authentication, and error handling.
user: Create user documentation that explains how to use the product or service from an end-user perspective.
admin: Create administrator documentation that explains how to configure, manage, and troubleshoot the system.
architecture: Create architecture documentation that explains the system design, components, and their interactions.

Format Options¶

markdown: Format the documentation in Markdown syntax.
javadoc: Format the documentation in Javadoc syntax.
jsdoc: Format the documentation in JSDoc syntax.
openapi: Format the documentation following OpenAPI specification.
restructuredtext: Format the documentation in reStructuredText syntax.
html: Format the documentation in HTML.
jupyter: Format the documentation as a Jupyter notebook with explanatory cells.

Detail Options¶

minimal: Include only essential information with brief descriptions.
standard: Include standard level of detail with examples and explanations.
comprehensive: Include exhaustive details, examples, edge cases, and cross-references.

Examples¶

Creating comprehensive API documentation in Markdown¶

+++Documentation(for=api, format=markdown, detail=comprehensive)
Create documentation for our payment processing API including authentication, endpoints, request/response formats, and error handling.

The model will generate comprehensive API documentation in Markdown format, covering all aspects of the payment processing API with detailed examples, error scenarios, and cross-references.

Creating minimal user documentation¶

+++Documentation(for=user, format=html, detail=minimal)
Document how to use our photo editing application.

The model will generate concise user documentation in HTML format, covering only the essential features and workflows of the photo editing application.

Creating standard code documentation¶

+++Documentation(for=code, format=jsdoc, detail=standard)
Document this JavaScript utility function library.

The model will generate standard JSDoc documentation for the JavaScript utility functions, including function signatures, parameters, return values, and basic usage examples.

Model-Specific Implementations¶

gpt-4-turbo¶

Instruction: Generate detailed documentation following these specifications:

Notes: For smaller models, be more explicit about documentation structure requirements.

claude-3-7-sonnet-latest¶

Instruction: Please create well-structured documentation with the following characteristics:

Notes: Claude models respond well to clear structure guidance in documentation tasks.

Implementation Guidance¶

API Documentation¶

Original Prompt:

Create documentation for our payment processing API.

Transformed Prompt:

Create API documentation that includes endpoints, request/response formats, authentication, and error handling. Format the documentation in Markdown syntax. Include standard level of detail with examples and explanations.

Create documentation for our payment processing API.

Notes: The decorator adds specific guidance on what elements to include in API documentation.

Code Documentation¶

Original Prompt:

Document this Python class for calculating mortgage payments.

Transformed Prompt:

Create code documentation that explains the implementation details, functions, classes, and methods. Format the documentation in reStructuredText syntax. Include exhaustive details, examples, edge cases, and cross-references.

Document this Python class for calculating mortgage payments.

Notes: The decorator specifies the format and level of detail for code documentation.

Transformation Details¶

Base Instruction: Create comprehensive documentation based on the provided content.

Placement: prepend

Composition Behavior: override

Parameter Effects:

for:
When set to code: Create code documentation that explains the implementation details, functions, classes, and methods.
When set to api: Create API documentation that includes endpoints, request/response formats, authentication, and error handling.
When set to user: Create user documentation that explains how to use the product or service from an end-user perspective.
When set to admin: Create administrator documentation that explains how to configure, manage, and troubleshoot the system.
When set to architecture: Create architecture documentation that explains the system design, components, and their interactions.
format:
When set to markdown: Format the documentation in Markdown syntax.
When set to javadoc: Format the documentation in Javadoc syntax.
When set to jsdoc: Format the documentation in JSDoc syntax.
When set to openapi: Format the documentation following OpenAPI specification.
When set to restructuredtext: Format the documentation in reStructuredText syntax.
When set to html: Format the documentation in HTML.
When set to jupyter: Format the documentation as a Jupyter notebook with explanatory cells.
detail:
When set to minimal: Include only essential information with brief descriptions.
When set to standard: Include standard level of detail with examples and explanations.
When set to comprehensive: Include exhaustive details, examples, edge cases, and cross-references.

Compatibility¶

Requires: None
Conflicts: ELI5, Simplify
Compatible Models: gpt-4o, gpt-4-turbo, claude-3-7-sonnet-latest, llama-3.2, palm-2
Standard Version: 1.0.0 - 2.0.0

CodeAnalysis: Enhances Documentation Documentation works well after CodeAnalysis to document the analyzed code.
ELI5: Conflicts with Documentation ELI5 simplifies content while Documentation formalizes it, creating potential conflicts in tone and detail level.