doc-template

Generate Documentation Template

Generate a documentation template for common document types.

Instructions

1. Parse arguments:

   • type: guide, api, tutorial, reference, changelog, troubleshooting
   • title (optional): Title for the document

2. Generate the appropriate template:

Guide Template (guide)

---
title: "${TITLE}"
category: "Guides"
tags: ["guide"]
order: 1
---

# ${TITLE}

Brief introduction explaining what this guide covers and who should read it.

## Prerequisites

Before you begin, ensure you have:

- Prerequisite 1
- Prerequisite 2

## Overview

High-level explanation of the topic.

## Step 1: First Step

Detailed instructions for the first step.

\`\`\`bash
$ example command
\`\`\`

## Step 2: Second Step

Detailed instructions for the second step.

## Verification

How to verify the setup/configuration is working.

## Troubleshooting

Common issues and their solutions.

## Next Steps

- [Related Guide 1](./related-guide-1.md)
- [Related Guide 2](./related-guide-2.md)

API Template (api)

---
title: "${TITLE}"
category: "API Reference"
tags: ["api"]
order: 1
---

# ${TITLE}

Brief description of what this API/tool does.

## Signature

\`\`\`python
def function_name(
    required_param: str,
    optional_param: Optional[str] = None
) -> ReturnType:
    """Function description."""
\`\`\`

## Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `required_param` | `str` | Yes | - | Description |
| `optional_param` | `str` | No | `None` | Description |

## Returns

`ReturnType` - Description of what is returned.

## Raises

| Exception | Condition |
|-----------|-----------|
| `ValueError` | When input is invalid |
| `FileNotFoundError` | When file doesn't exist |

## Examples

### Basic Usage

\`\`\`python
result = function_name("value")
print(result)
\`\`\`

### Advanced Usage

\`\`\`python
result = function_name(
    required_param="value",
    optional_param="option"
)
\`\`\`

## Related

- [Related API 1](./related-api-1.md)
- [Related API 2](./related-api-2.md)