Skip to main content
AI Writing Automation for Mac | Echoo
All Workflows

Code Review to Documentation

Turn code review comments and diffs into clean, structured markdown documentation that your team can reference long after the PR is merged.

3 steps

Workflow Steps

  1. Paste Code Review Content

    Copy the relevant code snippet and review comments from your PR. Include both the reviewer feedback and the code context.

    command: code-improver

  2. Generate Documentation Draft

    Echoo analyzes the code and review context to produce a structured explanation covering what the code does, why design decisions were made, and any caveats.

    command: professional-tone

  3. Convert to Markdown

    Format the documentation with proper headings, code fences, and cross-references so it drops straight into your docs site or wiki.

    command: to-markdown

Example

Input

// Review comment: "This retry logic is subtle -- we should document why we use exponential backoff with jitter here instead of fixed intervals." async function fetchWithRetry(url: string, maxRetries = 3) { for (let i = 0; i < maxRetries; i++) { try { return await fetch(url); } catch (err) { const delay = Math.pow(2, i) * 1000 + Math.random() * 500; await new Promise(r => setTimeout(r, delay)); } } throw new Error(`Failed after ${maxRetries} retries`); }

Output

## `fetchWithRetry` -- Resilient HTTP Fetching ### Overview Retries failed HTTP requests up to `maxRetries` times using **exponential backoff with jitter**. ### Why Exponential Backoff + Jitter? - **Exponential backoff** (`2^i * 1000ms`) prevents overwhelming a recovering server with rapid retries. - **Jitter** (`Math.random() * 500ms`) staggers concurrent callers so they don't all retry at the same instant (the "thundering herd" problem). ### Parameters | Param | Type | Default | Description | |-------|------|---------|-------------| | `url` | `string` | -- | The endpoint to fetch | | `maxRetries` | `number` | `3` | Maximum retry attempts | ### Error Handling Throws after exhausting all retries. Callers should wrap in try/catch.

Tips

1

Include the original reviewer comment so Echoo understands what needs explaining.

2

Ask for a specific doc format (API reference, tutorial, ADR) for more targeted output.

3

Chain multiple code snippets in one pass to build a full module doc.

4

Review the output for accuracy -- AI can misinterpret domain-specific logic.

Frequently Asked Questions

Explore More

Code Review Shortcuts Use Case

Convert Text To Markdown Use Case

Rewrite Professional Tone Use Case

Code Improver Command

To Markdown Command

Professional Tone Command

All workflows All use cases All commands

Ready to Try It?

Download Echoo and start automating text workflows with AI shortcuts.