dart-write-documentation Skill for Claude: Dart Doc Comment Rules From the Flutter Team

Makes Claude write Dart /// doc comments by the Effective Dart documentation rules, then check them with dart analyze.

Installs: 9.6K; on skills.sh
Stars: 3.1K; on GitHub
Updated: Nov 2026; last repo commit

It applies when you ask Claude to document Dart code. The rules cover scope, openers, banned Javadoc-style tags such as @param and @return, where doc comments go relative to annotations, and how to link symbols. It ends with a check: run dart analyze so every bracketed reference resolves, and optionally dart doc.

It sits in the Flutter team's agent-plugins repo and is one SKILL.md with 5 before-and-after examples. It bundles no scripts, but the check needs the Dart SDK on your machine.

Good for

Dart and Flutter developers documenting packages or apps
Package authors whose doc comments feed generated API reference pages
Reviewers who want one written standard for Dart doc comments

Install dart-write-documentation

Claude Code

Copy this prompt.

Install the dart-write-documentation skill in Claude Code. Run this command:

claude plugin marketplace add flutter/agent-plugins
claude plugin install dart-flutter@dart-flutter

Then check that it loaded and tell me how to use it.

2
Paste it into Claude Code. It shows the change and asks before running it.

Pick one route, not both. The plugin installs the repo's 25 skills and a Dart MCP server. The Flutter docs add that Claude Code plugins do not load plugin rules automatically; to use the official Flutter rules, add the ones you want to your project's CLAUDE.md. The check step needs the Dart SDK on your PATH.

From the vendor's docs. Source.

What's in the skill

When it loads

Rules and formatting guidelines for writing Dart /// API documentation and doc comments. Use when documenting Dart code, writing doc comments for any Dart declaration (libraries, classes, methods, variables, etc.), or when instructed to follow the Effective Dart documentation guidelines.

Sections in SKILL.md

Contents
1. Scope and Structure
2. Tone and Openers
3. Strict Anti-Patterns (Banned)
4. Technical Placement & Resolution
5. Linking and Markdown
6. Verification
Examples
1. Banned Tags vs. Prose
2. The Annotation Placement Trap
3. Openers and Tone
4. Constructor Linking
5. Out-of-Scope Links (@docImport)

Key facts

Source: Flutter team's agent-plugins repo (vendor's own repo)
Part of plugin: dart-flutter: Flutter and Dart skills plus the Dart MCP server (25 skill folders in the repo)
Folder: 1 file: SKILL.md
Needs for the check: Dart SDK (dart analyze, optionally dart doc)
Installs on skills.sh: 9,585 (Nov 2, 2026)
GitHub stars: 3,136 (Nov 2, 2026)
License: BSD-3-Clause
Last repo commit: Nov 1, 2026

What it includes

Document public APIs with /// lines, proper sentences and a one-sentence first paragraph.
Private members are skipped unless you say otherwise. Block comments are never used.
1. Scope and Structure
Noun phrases for properties, 'Whether' for booleans, third-person verbs for methods.
It avoids restating the element name or saying 'This class is a...'.
2. Tone and Openers
No @param, @return, @returns, @throws, @exception, @see or @type.
Parameter names, return behavior and exceptions go into the prose instead.
3. Banned tags
Doc comments come before annotations; document the getter, not the setter.
Overrides inherit docs when behavior does not differ. Link a default constructor with .new, as in [ClassName.new].
4. Technical Placement
Square brackets for in-scope symbols, backticks for keywords and labeled code fences.
A symbol that is out of scope is linked with a @docImport directive rather than a normal import.
5. Linking and Markdown
Runs dart analyze, and optionally dart doc, after writing the comments.
The check makes sure bracketed references resolve without comment_references warnings.
Runs code · 6. Verification
5 bad-versus-good pairs on tags, annotations, openers, constructors, @docImport.
Each pair shows the wrong version first and the fixed version second.
Try: “Document the public API in lib/src/client.dart following the dart-write-documentation skill.”
Examples

From the official docs

Permissions

Low risk

Claude edits doc comments in your Dart files and runs dart analyze. The plugin route also adds 24 other skills and a Dart MCP server.

What it can do

Read your data
Create and change things
Delete things
Read-only mode

Watch out for

It edits Dart files and runs the Dart analyzer
Claude adds or rewrites /// comments and then runs dart analyze. Use git and review the diff. github.com
The plugin route adds 24 more skills and an MCP server
The dart-flutter plugin manifest declares one MCP server that runs dart mcp-server and no hooks. The repo also has .agents/hooks.json with two Stop hooks (dart format and dart analyze scripts), which the Claude manifest does not reference. Use the skills CLI route to install only this skill. github.com

Technical details

Scopes	Edits doc comments in your Dart files Runs dart analyze, and optionally dart doc, in your project Plugin route only: starts the dart mcp-server command as an MCP server

Questions

What does dart-write-documentation do?

It gives Claude the Flutter team's rules for writing Dart API doc comments. They follow the Effective Dart documentation guidelines: how to open a comment, which tags are banned, where comments sit and how to link.

Is it made by the Dart or Flutter team?

It is in the Flutter team's own repo, flutter/agent-plugins, which the README says is maintained by the Flutter team. The repo's plugin manifest lists Dart and Flutter as author.

How do I install it?

Use the install box above. In Claude Code, the Flutter docs' route is the dart-flutter plugin, which installs all of the repo's Flutter and Dart skills and a Dart MCP server. For this skill alone, use the skills CLI command. There is no Claude app tab because the check runs the Dart SDK.

Do I need the Dart SDK?

For the final check, yes. SKILL.md tells Claude to run dart analyze, and optionally dart doc. Writing the comments itself needs no tools.

Does it document private members?

Not unless you ask. SKILL.md says to focus on public declarations because private members do not appear in generated API reference sites.

Is it safe to use?

The skill folder bundles no scripts, and it edits Dart files by adding or changing doc comments, so review the diff before you commit. The plugin route adds more, including a local Dart MCP server.

Information

updated Nov 2, 2026

Repository: flutter/agent-plugins
Folder: skills/dart-write-documentation

flutter/agent-plugins skills.sh

Sources

Docs, issue trackers and discussions this page is built from.

Show all 4

dart-write-documentation SKILL.md · github.com
flutter/agent-plugins README · github.com
dart-flutter plugin.json · github.com
Get started developing with AI · docs.flutter.dev