update-docs

Update Documentation

Systematically verify and update project documentation using parallel explore agents in explore-exploit turns.

Overview

This skill uses an adaptive approach:

1. Discovery - Map what documentation exists in the project
2. Planning - Determine which areas can be explored in parallel
3. Exploration - Dispatch agents based on discovered structure
4. Exploitation - Apply fixes and updates

Arguments

If $ARGUMENTS provided, use as a focus hint but still discover the actual structure first.

Phase 1: Discovery (Single Agent)

Launch ONE discovery agent first to map the documentation landscape:

subagent_type: "Explore"
description: "Map documentation structure"
prompt: |
  Map all documentation in this project.

  Tasks:
  1. Find all documentation files and directories:
     - Glob for **/*.md, **/docs/**, **/*.rst, **/*.txt
     - Check for swagger/openapi specs
     - Find .env.example, config examples
     - Look for diagrams (*.mmd, *.puml, *.drawio)

  2. Categorize what exists:
     - README files (root and nested)
     - API documentation
     - Setup/installation guides
     - Architecture/design docs
     - Implementation plans/specs
     - Inline code documentation patterns
     - Configuration documentation
     - Changelogs/release notes

  3. Note project characteristics:
     - Approximate size (file count)
     - Primary language/framework
     - Documentation style/format used

  4. Identify documentation gaps:
     - Directories with no README
     - Undocumented public APIs
     - Missing setup instructions

  Write findings to .tmp/docs-audit/discovery.md

  Format:
  ## Documentation Map

  ### Project Profile
  - Size: [small/medium/large]
  - Language: [primary language]
  - Framework: [if applicable]

  ### Documentation Found
  | Category | Files | Status |
  |----------|-------|--------|
  | README | [list] | [exists/missing] |
  | API Docs | [list] | [exists/missing] |
  ...

  ### Recommended Parallel Exploration Areas
  Based on what exists, these areas can be explored in parallel:
  1. [area]: [files to check]
  2. [area]: [files to check]
  ...

  ### Gaps Identified
  - [gap description]