flow-documenter_skill

Overview

This skill helps you document discoveries, decisions, and task notes using the Flow framework. It keeps documentation concise, actionable, and synchronized with ongoing work. Use it to update Task Notes, produce summaries, and generate changelogs aligned with Flow patterns.

How this skill works

When you ask to document or summarize, the skill captures discoveries, design decisions, challenges, and references into the appropriate Task ## Notes, DASHBOARD.md, or PLAN.md sections. It applies Flow templates for Notes, Bug reports, Discoveries, and Changelogs and can run /flow-summarize to produce high-level project summaries. The output is short, actionable entries that link to tasks, iterations, and external references when relevant.

When to use it

• You want to "document this" discovery or decision
• Add notes to a task during or after implementation
• Summarize work for a changelog or release notes
• Record a bug, workaround, or follow-up task
• Update DASHBOARD or PLAN.md with phase or task summaries

Best practices

• Place entries in the correct location: Task ## Notes, DASHBOARD.md, or PLAN.md
• Keep entries concise and focused on why something matters, not just what changed
• Use provided templates for Notes, Bugs, Discoveries, and Changelogs for consistency
• Link related tasks, iterations, and external docs for traceability
• Mark follow-up actions and priorities so reviewers and implementers know next steps

Example use cases

• Document an unexpected library limitation discovered during implementation and the chosen workaround
• Record a design decision with rationale and deferred items for V2
• Capture a reproducible bug with location, impact, action taken, and recommended fix
• Generate a changelog for a release from completed tasks and implementation summaries
• Update DASHBOARD.md after completing a phase to reflect progress and next steps