flutter-documentation
Installation
SKILL.md
Flutter Documentation
Generate and maintain project documentation that helps the team understand, extend, and onboard onto the Flutter app.
Workflow
- Identify what needs documenting — new feature, architecture decision, release, or onboarding gap.
- Read the project state first — inspect
README.md,docs/,lib/,pubspec.yaml. Never write docs that contradict the actual code. - Choose the right template from
templates/(see Output Artifacts below). - Draft the document — fill all required sections; mark
[TODO]for sections requiring user input. - Review for accuracy — every file path, command, and class name must exist in the current codebase.
- Update the README if new commands, env vars, setup steps, or architecture patterns were introduced.
- Cross-link — new feature docs should be referenced from
docs/architecture/technical_plan.mdor the relevant ADR.