120 lines
2.4 KiB
Markdown
120 lines
2.4 KiB
Markdown
# {{PACKAGE_NAME}} v{{VERSION}} - Usage Manual
|
|
|
|
<!-- SCOPE: API/Method reference ONLY. Contains technical descriptions, parameters, examples. -->
|
|
<!-- DO NOT add: How-to instructions → Guide, Decision rationale → ADR -->
|
|
|
|
## Package Information
|
|
|
|
**Package:** {{PACKAGE_NAME}}
|
|
**Version:** {{VERSION}}
|
|
**Installation:** `{{INSTALL_COMMAND}}`
|
|
**Documentation:** {{OFFICIAL_DOCS_URL}}
|
|
|
|
## Overview
|
|
|
|
{{PACKAGE_DESCRIPTION}}
|
|
|
|
## Methods We Use
|
|
|
|
---
|
|
|
|
### {{METHOD_1_NAME}}
|
|
|
|
**Signature:**
|
|
```{{LANGUAGE}}
|
|
{{METHOD_1_SIGNATURE}}
|
|
```
|
|
|
|
**Description:**
|
|
{{METHOD_1_DESCRIPTION}}
|
|
|
|
**Parameters:**
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| {{PARAM_1_NAME}} | {{PARAM_1_TYPE}} | {{PARAM_1_REQUIRED}} | {{PARAM_1_DEFAULT}} | {{PARAM_1_DESCRIPTION}} |
|
|
| {{PARAM_2_NAME}} | {{PARAM_2_TYPE}} | {{PARAM_2_REQUIRED}} | {{PARAM_2_DEFAULT}} | {{PARAM_2_DESCRIPTION}} |
|
|
|
|
**Returns:**
|
|
|
|
{{RETURN_TYPE}} - {{RETURN_DESCRIPTION}}
|
|
|
|
**Raises:**
|
|
|
|
* `{{EXCEPTION_1}}` - When {{EXCEPTION_1_CONDITION}}
|
|
* `{{EXCEPTION_2}}` - When {{EXCEPTION_2_CONDITION}}
|
|
|
|
**Example:**
|
|
```{{LANGUAGE}}
|
|
{{EXAMPLE_CODE}}
|
|
```
|
|
|
|
**Output:**
|
|
```
|
|
{{EXAMPLE_OUTPUT}}
|
|
```
|
|
|
|
{{METHOD_1_WARNINGS}}
|
|
|
|
---
|
|
|
|
### {{METHOD_2_NAME}}
|
|
|
|
**Signature:**
|
|
```{{LANGUAGE}}
|
|
{{METHOD_2_SIGNATURE}}
|
|
```
|
|
|
|
**Description:**
|
|
{{METHOD_2_DESCRIPTION}}
|
|
|
|
**Parameters:**
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| {{PARAM_1_NAME}} | {{PARAM_1_TYPE}} | {{PARAM_1_REQUIRED}} | {{PARAM_1_DEFAULT}} | {{PARAM_1_DESCRIPTION}} |
|
|
|
|
**Returns:**
|
|
|
|
{{RETURN_TYPE}} - {{RETURN_DESCRIPTION}}
|
|
|
|
**Raises:**
|
|
|
|
* `{{EXCEPTION_1}}` - When {{EXCEPTION_1_CONDITION}}
|
|
|
|
**Example:**
|
|
```{{LANGUAGE}}
|
|
{{EXAMPLE_CODE}}
|
|
```
|
|
|
|
---
|
|
|
|
## Configuration
|
|
|
|
{{CONFIGURATION_SECTION}}
|
|
|
|
| Option | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| {{CONFIG_1_NAME}} | {{CONFIG_1_TYPE}} | {{CONFIG_1_DEFAULT}} | {{CONFIG_1_DESCRIPTION}} |
|
|
| {{CONFIG_2_NAME}} | {{CONFIG_2_TYPE}} | {{CONFIG_2_DEFAULT}} | {{CONFIG_2_DESCRIPTION}} |
|
|
|
|
## Known Limitations
|
|
|
|
{{LIMITATIONS}}
|
|
|
|
* {{LIMITATION_1}}
|
|
* {{LIMITATION_2}}
|
|
|
|
## Version-Specific Notes
|
|
|
|
{{VERSION_NOTES}}
|
|
|
|
## Related Resources
|
|
|
|
* **Official Documentation:** {{OFFICIAL_DOCS_LINK}}
|
|
* **GitHub Repository:** {{GITHUB_URL}}
|
|
* **Related Guides:** {{RELATED_GUIDES}}
|
|
* **Related ADRs:** {{RELATED_ADRS}}
|
|
|
|
**Last Updated:** {{DATE}}
|