Files
roboco/.tasks/templates/documentation.md
T
2025-12-10 02:49:54 +01:00

2.9 KiB

TASK-{ID}: {Title}

Template: Documentation Created: YYYY-MM-DD Last Updated: YYYY-MM-DD


Status

Field Value
State pending
Priority P{0-3}
Cell {backend / frontend / ux_ui}
Assigned To {agent-id or "unassigned"}
Source Task {TASK-XXX or "standalone"}

Timeline

Milestone Date
Created YYYY-MM-DD
Started -
Draft Complete -
Reviewed -
Published -

Overview

{What documentation needs to be created or updated?}

Trigger

{What prompted this documentation task?}

  • New feature (TASK-XXX)
  • Updated feature (TASK-XXX)
  • Documentation gap identified
  • User feedback
  • Other: {specify}

Documentation Scope

Documents to Create/Update

Document Type Location Action
{doc name} {API / component / guide / etc.} {path} {create / update}
{doc name} {type} {path} {action}

Content Requirements

  • {Content area 1}
  • {Content area 2}
  • {Content area 3}

Source Materials

From Development Task

{If this docs task is from a feature/bugfix}

  • Source Task: {TASK-XXX or "N/A"}
  • Journey Notes: {path to journal.md}
  • Handoff Notes: {path to handoff.md}
  • Commits: {list of relevant commits}

Reference Materials

  • {Existing documentation to reference}
  • {Code to document}
  • {Figma/design links}
  • {Conversation links}

Documentation Checklist

Content

  • Accurate - reflects current implementation
  • Complete - covers all relevant aspects
  • Clear - understandable without prior context
  • Examples - includes working examples
  • Edge cases - documents limitations and gotchas

Format

  • Follows documentation style guide
  • Proper headings and structure
  • Code blocks formatted correctly
  • Links working
  • Images/diagrams included (if applicable)

Review

  • Technical accuracy verified
  • Spell/grammar checked
  • Reviewed by {reviewer or "self-reviewed"}

Draft

{Documentation draft or link to draft location}

Document 1: {Title}

{Draft content here or in separate file}

Publication

Locations

{Where will this documentation be published?}

  • {Location 1: e.g., docs/api/endpoint.md}
  • {Location 2: e.g., README.md update}
  • {Location 3: e.g., changelog entry}

Changelog Entry

## [version] - YYYY-MM-DD

### Documentation
- {What was documented}

Quick Context Restore

Current state: Not started Draft status: Not started Review status: Not reviewed


Notes

{Additional context, style notes, audience considerations}


Changelog

Date Agent Change
YYYY-MM-DD {agent} Documentation task created