61 lines
1.2 KiB
Markdown
61 lines
1.2 KiB
Markdown
# Feature Name
|
|
|
|
> Brief one-line description of what this feature does
|
|
|
|
## Overview
|
|
|
|
Explain what this feature does and why it exists. Include:
|
|
- The problem it solves
|
|
- Key capabilities
|
|
- When to use it
|
|
|
|
## Usage
|
|
|
|
### Basic Example
|
|
|
|
```typescript
|
|
// Code example showing basic usage
|
|
```
|
|
|
|
### Advanced Example
|
|
|
|
```typescript
|
|
// Code example showing advanced/common patterns
|
|
```
|
|
|
|
## Configuration
|
|
|
|
| Option | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `option1` | `string` | `""` | Description of option |
|
|
| `option2` | `boolean` | `false` | Description of option |
|
|
|
|
## Components
|
|
|
|
List the main components involved in this feature:
|
|
|
|
| Component | Location | Purpose |
|
|
|-----------|----------|---------|
|
|
| `ComponentName` | `src/components/ComponentName.vue` | Brief description |
|
|
|
|
## Data Flow
|
|
|
|
Describe how data flows through this feature (if applicable):
|
|
|
|
```
|
|
User Action → Component → Store → API → Database
|
|
↑ ↓
|
|
UI Update ← ← ← ← Response
|
|
```
|
|
|
|
## Related
|
|
|
|
- [Related Feature](./feature-related.md)
|
|
- [Related Component](./component-related.md)
|
|
|
|
## Changelog
|
|
|
|
| Date | Change |
|
|
|------|--------|
|
|
| YYYY-MM-DD | Initial implementation |
|