Skip to content

[plan] Create reusable documentation templates to reduce token usage #12198

@github-actions

Description

@github-actions

Objective

Develop reusable documentation templates (INDEX, README, QUICKREF, EXAMPLE, CONFIG) that reduce token consumption while maintaining quality and consistency.

Context

Research from #12193 shows the agent creates similar documentation structures across workflows (~60-70 KB per package with 5-7 files). The consistent patterns (INDEX navigation, README setup, QUICKREF cheat sheets, etc.) suggest opportunities for template reuse to optimize token usage without sacrificing quality.

Approach

  1. Extract common documentation structures into templates:
    • INDEX.md template with navigation structure
    • README.md template with setup sections
    • QUICKREF.md template with command reference format
    • EXAMPLE.md template with sample output structure
    • CONFIG-TEMPLATE.md template with deployment checklist
  2. Store templates in pkg/workflow/templates/ or similar location
  3. Update agent instructions to reference templates and fill in workflow-specific details
  4. Measure token reduction vs comprehensive generation

Files to Create

  • pkg/workflow/templates/INDEX.template.md
  • pkg/workflow/templates/README.template.md
  • pkg/workflow/templates/QUICKREF.template.md
  • pkg/workflow/templates/EXAMPLE.template.md
  • pkg/workflow/templates/CONFIG.template.md

Files to Modify

  • .github/instructions/*.instructions.md - Reference templates in agent instructions
  • pkg/workflow/compiler.go - Template loading and interpolation logic
  • AGENTS.md - Document template usage guidelines

Acceptance Criteria

  • Templates created for all 5 common documentation files
  • Templates include placeholder syntax for workflow-specific content
  • Agent instructions reference templates appropriately
  • Generated documentation maintains quality standards
  • Token usage reduced (measure before/after)
  • Tests validate template interpolation

Reference

See discussion #12193 "Recommendations" section: "Template Reuse"

AI generated by Plan Command for discussion #12193

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions