---
name: docs-from-code
description: Turn implementation details into practical documentation such as README updates, setup guides, a…
category: documentation
runtime: no special runtime
---

# docs-from-code output preview

## PART A: Task fit
- Use case: Turn implementation details into practical documentation such as README updates, setup guides, architecture notes, runbooks, changelogs, and internal reference docs. Use when code exists but docs lag behind or when shipping a feature requires clear documentation..
- Inputs: target material, constraints, expected output, and acceptance criteria.
- Evidence boundary: follow “Overview / Core Workflow / Deliver” and do not present inference as author intent.

## PART B: Execution result
- **01** The card summarizes the use case; runtime output centers on “Turn implementation details into practical documentation such as README updates, setup guides, architecture notes, runbooks, changelogs, and internal reference docs. Use when code exists but docs lag behind or when shipping a feature requires clear documentation.”.
- **02** When the source has headings, the agent prioritizes “Overview / Core Workflow / Deliver” so the result follows the author’s structure.
- **03** Typical output includes task judgment, concrete steps, required commands or file edits, validation, and follow-up options.
- **04** Risk context follows the fingerprint: read files, write/modify files; mostly runs locally; usually needs no extra API key.

## Running Rules
- read files, write/modify files; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding scope.
- Return the result, validation criteria, and next iteration options.