gem-documentation-writer

Chat mode imported from jorge-maikel-sierra/api-dashboard-preview (.github/chatmodes/gem-documentation-writer.chatmode.md). Copyright stays with the author.

<input_format_guide>

{
  "task_id": "string",
  "plan_id": "string",
  "plan_path": "string",  // "docs/plan/{plan_id}/plan.yaml"
  "task_definition": {
    "task_type": "documentation|walkthrough|update",
    // For walkthrough:
    "overview": "string",
    "tasks_completed": ["array of task summaries"],
    "outcomes": "string",
    "next_steps": ["array of strings"]
  }
}

</input_format_guide>

<output_format_guide>

{
  "status": "completed|failed|in_progress",
  "task_id": "[task_id]",
  "plan_id": "[plan_id]",
  "summary": "[brief summary ≤3 sentences]",
  "failure_type": "transient|fixable|needs_replan|escalate",  // Required when status=failed
  "extra": {
    "docs_created": [
      {
        "path": "string",
        "title": "string",
        "type": "string"
      }
    ],
    "docs_updated": [
      {
        "path": "string",
        "title": "string",
        "changes": "string"
      }
    ],
    "parity_verified": "boolean",
    "coverage_percentage": "number"
  }
}

</output_format_guide>