Templates Folder

Purpose

Centralized templates for all poe-aio documentation. Every document MUST derive from a template.

Available Templates

Template	File	Use Cases	Document Type	Version
Build Template	build-template.md	Character build guides	build	1.1.0
Class Template	class-template.md	Character classes	class	1.0.0
Skill Template	skill-template.md	Skill gems, abilities, supports	skill	1.1.0
Item Template	item-template.md	Unique items, equipment	item	1.1.0
Mechanic Template	mechanic-template.md	Game mechanics, systems	mechanic	1.1.0
League Template	league-template.md	League-specific mechanics	league	1.1.0
Guide Template	guide-template.md	How-to guides, strategies	guide	1.1.0
Research Template	research-template.md	Analysis, theorycrafting	research	1.1.0

Template Selection Guide

When to Use Each Template

build-template.md

• Full character build guides
• Includes skill trees, gear, leveling
• Location: builds/[class]/

class-template.md

• Character classes (Duelist, Witch, Marauder, etc.)
• Base stats, ascendancies, lore
• Location: mechanics/classes/

skill-template.md

• Active skill gems
• Support gems
• Vaal skills
• Location: mechanics/skills/

item-template.md

• Unique items
• Special equipment
• Notable uniques
• Location: mechanics/items/

mechanic-template.md

• Core game mechanics
• Systems and interactions
• Crafting methods
• Location: mechanics/[category]/

league-template.md

• League-specific mechanics
• Temporary content (that became permanent)
• Location: mechanics/leagues/

guide-template.md

• Strategy guides
• How-to instructions
• Optimization guides
• Location: research/strategy/

research-template.md

• Meta analysis
• Theorycrafting
• Data analysis
• Location: research/[category]/

Template Requirements

ALL Templates MUST Include

Required Frontmatter:

template: "templates/[template-name].md"  # Path to this template
document_type: "[appropriate-type]"       # See table above
title: "[Document Title]"
status: "draft|review|published|outdated"
author: "[Your Name]"
created: "YYYY-MM-DD"
updated: "YYYY-MM-DD"
tags: ["tag1", "tag2"]
league: "3.25"                           # Current league
patch: "3.25.1"                          # Current patch

Template-Specific Fields

Each template may require additional fields beyond the common ones. Always read the template before using it.

Note: All templates use title as the primary field name for the document's title. This is consistent across all document types.

Usage Workflow

Step 1: Choose Template

Determine which template fits your content type.

Step 2: Read Template

Read("templates/[template-name].md")

Review:

• Required frontmatter fields
• Document structure
• Content sections
• Example values with specific ranges

Step 3: Copy Template Structure

Use the template's outline and required fields.

Step 4: Fill with Specific Values

Use concrete numbers from examples provided:

• Follow the inline examples in templates
• Use specific values, not vague placeholders
• Reference inline definitions for consistent ratings

Step 5: Add Template Reference

CRITICAL: Include template path in frontmatter:

template: "templates/build-template.md"  # Example

Path Conventions

Template Paths

When referencing templates in frontmatter, always use absolute paths:

✅ CORRECT:

template: "templates/build-template.md"

❌ INCORRECT:

template: "../templates/build-template.md"
template: "./build-template.md"

Creating New Templates

When to Create a Template

Create a new template when:

• New content type doesn't fit existing templates
• Repeated structure appears across multiple documents
• Specific validation rules needed

Template Creation Guidelines

File Location: templates/[name]-template.md

Template Structure:

---
# Template Metadata
template_name: "[name]-template"
template_version: "1.0.0"
created: "YYYY-MM-DD"
updated: "YYYY-MM-DD"
---

# [Template Name]

## Frontmatter Requirements
[List required and optional fields]

## Document Structure
[Outline sections and content]

## Usage Examples
[Show how to use this template]

## Validation Rules
[Describe what makes a valid document]

Update This Index: Add new template to the table above.

Template Versioning

Templates use semantic versioning:

• 1.0.0 - Initial template
• 1.1.0 - New optional fields added
• 2.0.0 - Breaking changes to structure

When updating templates:

1. Increment version in template metadata
2. Update updated date
3. Document changes in template file
4. Update this index if needed

Validation

Required Validation Checks

Every document MUST:

1. ✅ Include template: field in frontmatter
2. ✅ Reference a valid template file
3. ✅ Include all required frontmatter fields
4. ✅ Follow template structure
5. ✅ Use absolute paths

Validation Commands

# Check for documents without template field
grep -L "template:" [folder]/**/*.md

# Verify template references exist
# (check that referenced template files exist)

# Find outdated documents
grep "status: \"outdated\"" **/*.md

Template Best Practices

1. Required Fields Only

Only mark fields as required if absolutely necessary.

2. Clear Structure

Templates should have clear, logical sections.

3. Examples

Include example content in templates.

4. Flexibility

Allow customization while maintaining structure.

5. Documentation

Document why fields exist and how to use them.

Common Mistakes

❌ Missing Template Field

# Wrong - no template field
document_type: "build"
title: "My Build"

# Correct
template: "templates/build-template.md"
document_type: "build"
title: "My Build"

❌ Relative Paths

# Wrong
template: "../templates/build-template.md"

# Correct
template: "templates/build-template.md"

❌ Wrong Template

# Wrong - using build template for a skill
template: "templates/build-template.md"
document_type: "skill"

# Correct
template: "templates/skill-template.md"
document_type: "skill"

Quality Checklist

Before using a template:

• [ ] Read the template file completely
• [ ] Understand all required fields
• [ ] Review document structure
• [ ] Check example usage with specific values
• [ ] Verify template path is correct
• [ ] Confirm template fits content type

Before creating from template:

• [ ] Copy all required frontmatter fields
• [ ] Use absolute path for template reference
• [ ] Follow template structure
• [ ] Fill in all required sections with specific values
• [ ] Use inline definitions for consistent ratings/tiers
• [ ] Add appropriate tags
• [ ] Set correct document_type
• [ ] Replace ALL placeholders with real examples

After creating document:

• [ ] Run /validate skill to check compliance
• [ ] Verify all examples follow inline definitions
• [ ] Ensure no vague placeholders like "[X]" or "[Value]" remain

Additional Resources

• CLAUDE.md: Project overview and workflows
• Folder index.md files: Specific usage guidelines
• Template files: Detailed structure and examples

What Changed in Version 1.1.0

Major Update: All templates now include specific, measurable values inline!

Key Improvements

1. Inline Definitions

   • Rating scales defined directly in templates (1-5 stars)
   • Budget tiers with specific chaos/divine ranges included
   • DPS benchmarks shown in context
   • All definitions embedded where needed

2. Template Updates (All 1.0.0 → 1.1.0)

   • Replaced vague placeholders with concrete examples
   • Included specific value ranges throughout
   • Added inline measurement scales and rating definitions
   • Provided calculation examples (e.g., support gem DPS)

3. No More Guessing

   • "X Shaper DPS" → "e.g., 5-10M Shaper DPS (endgame tier)"
   • "[Rating]" → "⭐⭐⭐⭐ (Strong, 5M+ DPS capable)"
   • "[Budget]" → "2-10 divine (medium-budget tier)"
   • "[Time]" → "30-60 minutes (comprehensive guide)"

Migration: Existing documents don't need updates, but new documents should follow 1.1.0 standards.

---

Last Updated: 2025-11-04 Template Count: 8 Version: 1.1.0