convez.ai
PluginAutomaçãoIntermediário
primus852

Claude Flutter Documenter

primus852/claude-flutter-documenter

Converte código Flutter em documentação de usuário automaticamente

Ver no GitHub
InicialPluginScore · de 0 a 100

Plugin para Claude Code que lê codebases Flutter e gera manuais de usuário em Markdown com capturas de tela e fluxogramas Mermaid. Automatiza a primeira versão da documentação, mantendo a estrutura consistente enquanto você valida a precisão.

Instalação

$npx convez-ai primus852/claude-flutter-documenter

1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.

Métricas

Estrelas
0
Forks
0
Acompanhando
0
Saúde
42%
Último commit
há 6 meses
Versão
v0.2.6
Issues abertas
0
Contribuidores
1

Casos de uso

  • Gerar documentação de usuário final para apps Flutter em minutos
  • Criar manuais para administradores com detalhes técnicos de rotas e fluxos
  • Documentar funcionalidades avançadas para power-users com atalhos

Veredito

Solução prática que reduz drasticamente o esforço manual de documentação Flutter. Requer Flutter SDK configurado e dependências opcionais (Mermaid CLI) para máximo potencial; ideal para projetos com múltiplas telas e fluxos que evoluem frequentemente.

README

A tradução para o português deste README ainda está na fila.

claude-flutter-documenter

A Claude Code plugin that reads your Flutter codebase and produces a cross-linked end-user manual as a folder of Markdown files — complete with screenshots and Mermaid flowcharts.


Purpose

Writing user documentation for a Flutter app is tedious: screens multiply, flows change, and prose goes stale. claude-flutter-documenter automates the first draft by letting an LLM do what it's good at — reading code, drafting prose, and keeping structure consistent — while you stay in charge of accuracy.

One command turns a Flutter project into a ready-to-review manual:

  • Routes and screens discovered via MaterialApp / GoRouter analysis
  • Screenshots captured with flutter screenshot on a connected device or emulator
  • Mermaid flowcharts for multi-step user journeys, rendered to SVG if mmdc is installed
  • Prose in a consistent voice, tailored to your chosen audience (end-user, admin, power-user)

All output lands in .documenter/ inside your project and opens without any build step in VS Code, GitHub, or Obsidian.


Prerequisites

RequirementVersionNotes
Claude CodeLatestPlugin host
Node.js≥ 18Runs the analysis CLI
Flutter SDKAny stableMust be in PATH
Mermaid CLI (mmdc)AnyOptional — enables SVG diagram export

Installation

1. Add the plugin to Claude Code

/plugin marketplace add https://github.com/primus852/claude-flutter-documenter
/plugin install flutter-doc

2. Install optional system dependencies

brew install mermaid-cli   # enables SVG diagram export (optional)

For local development — clone the repo and point the marketplace at your checkout instead:

git clone https://github.com/primus852/claude-flutter-documenter ~/claude-flutter-documenter
/plugin marketplace add ~/claude-flutter-documenter
/plugin install claude-flutter-documenter

Quick Start

Open a Flutter project in Claude Code (the working directory must contain pubspec.yaml), then run:

/document

The plugin walks through six steps automatically:

  1. Detects your Flutter project (pubspec.yaml)
  2. Creates the .documenter/ output structure
  3. Analyzes routes, screens, and user journeys
  4. Captures screenshots (skippable if no device is connected)
  5. Generates Mermaid diagrams
  6. Drafts the manual chapters and index

Usage

/flutter-doc:document                           # guided run, auto-detects Flutter project
/flutter-doc:document end-user                  # audience = end-user (default)
/flutter-doc:document admin                     # audience = admin
/flutter-doc:document power-user                # audience = power-user
/flutter-doc:document --src lib/features/auth   # scope analysis to a subfolder
/flutter-doc:help                               # full command reference
/flutter-doc:do "update the settings chapter"   # freeform refinement

Audience modes

AudienceDescription
end-user (default)Step-by-step, plain language, screenshot on every screen
adminTechnical detail, assumes familiarity with the system
power-userKeyboard shortcuts and advanced flows

--src flag

Scope analysis to a specific subfolder when your app is large or monorepo-structured:

/document --src lib/features/onboarding

The path is saved in .documenter/config.json and becomes the default for all future runs on that project.


Sample output

The sample/ directory contains a complete documenter run against the Flutter counter demo app (flutter create):


Output

.documenter/
├── config.json              ← project settings (audience, locale, …)
├── analysis/
│   ├── routes.json          ← discovered routes / screens
│   ├── journeys.json        ← multi-step user flows
│   └── manifest.yaml        ← screenshot inventory
├── screenshots/
│   └── <route-id>.png
├── diagrams/
│   ├── <journey-id>.mmd     ← Mermaid source (always written)
│   └── <journey-id>.svg     ← only if mmdc is installed
└── manual/
    ├── index.md             ← start here
    ├── chapters/
    │   └── <chapter-id>.md
    ├── journeys/
    │   └── <journey-id>.md
    ├── troubleshooting.md
    └── getting-help.md

Open .documenter/manual/index.md in any Markdown viewer — all internal links resolve without a build step.


Commands

CommandDescription
/flutter-doc:document [audience] [--src path]Full pipeline: analyze → screenshot → diagram → draft
/flutter-doc:helpPrints all commands, options, and output structure
/flutter-doc:do "<text>"Routes a freeform request to the right sub-workflow

Configuration

.documenter/config.json is created on first run and persists your preferences:

{
  "projectName": "my_app",
  "sourceDir": "lib",
  "audience": "end-user",
  "version": "1.0",
  "contactEmail": "support@example.com",
  "contactUrl": "https://help.example.com",
  "locale": "en",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

Flags passed to /document always override saved values.


Stack

ConcernTool
Route / screen extractionRegex + GoRouter config parsing (Node.js CLI)
Screenshotsflutter screenshot + manifest YAML
FlowchartsMermaid CLI (mmdc) — optional
Manual proseClaude (via Claude Code agent workflow)

Update notifications

flutter-doc checks for a newer GitHub release at the start of every /flutter-doc:document run and prints a one-line notice if one is available.

For a persistent statusline indicator (like /gsd-update shows), add this to your project's .claude/settings.json:

{
  "statusCommand": "PLUGIN_ROOT=~/claude-flutter-documenter ~/claude-flutter-documenter/scripts/check-update.sh"
}

Replace ~/claude-flutter-documenter with the path to your local plugin checkout. The statusline will show flutter-doc vX.Y.Z available → /plugin update flutter-doc whenever a new release is out, and nothing when you're current.


Development

# Run the analysis CLI directly against a Flutter project:
node bin/documenter.cjs analyze-flutter ~/path/to/my-flutter-app

# Generate diagrams from an existing journeys file:
node bin/documenter.cjs diagrams ~/path/to/my-flutter-app/.documenter/analysis/journeys.json

Agent workflows live in workflows/, agent definitions in agents/, and Markdown chapter templates in templates/.


Roadmap

  • v0.2 — Localization (locale flag in config)
  • v0.2 — Flutter integration_test golden screenshots
  • v0.3 — GitHub Action for auto-generated docs on PR merge
  • v1.0 — WYSIWYG review mode inside Claude Code

License

MIT © Torsten Wolter

Ver o original no GitHub

Bom para

Relacionados