Now liveThe Skillselion MCP - thousands of ranked skills, loaded into your agent mid-task. No install.Get it →
flutter avatar

Proofread Markdown

  • 24 installs
  • 3.1k repo stars
  • Updated August 5, 2026
  • flutter/website

Proofreads Markdown files against the Google developer documentation style guide for line length, voice, word choice, and heading style.

About

Provides a checklist to transform technical Markdown into clear, style-guide-compliant text covering line wrapping, active voice, forbidden terms, and heading and list formatting. A developer uses it when editing Markdown docs to follow Google style guidelines.

  • Wrap lines under 80 chars and never touch front matter
  • Enforce active voice, present tense, second person, and sentence-case headings

Proofread Markdown by the numbers

  • 24 all-time installs (skills.sh)
  • Ranked #973 of 1,879 Documentation skills by installs in the Skillselion catalog
  • Data as of Aug 5, 2026 (Skillselion catalog sync)
npx skills add https://github.com/flutter/website --skill proofread-markdown

Add your badge

Show developers this skill is listed on Skillselion. Paste this into your README.

Listed on Skillselion
Installs24
repo stars3.1k
Last updatedAugust 5, 2026
Repositoryflutter/website

What it does

Proofreads Markdown files against the Google developer documentation style guide for line length, voice, word choice, and heading style.

Files

SKILL.mdMarkdownGitHub ↗

Proofreading Markdown

Overview

Help us transform technical text into clear, concise, and machine-readable Markdown. We follow the Google Developer Documentation Style Guide.

Workflow

1. Check line length

  • [ ] Wrap lines semantically and keep them generally under 80 characters using

scripts/wrap_lines.dart

  • [ ] Never touch the front matter.

Do not modify the content between the first two --- lines at the top of the file.

  • [ ] Verify that the file was wrapped correctly,

preserving headings and code blocks

2. Fix voice and tone

  • [ ] Use active voice.
  • [ ] Use present tense.
  • [ ] Use second person ("you"). No "we" or "I".

3. Check word choice

  • [ ] Replace forbidden terms: "e.g.", "i.e.", "etc.", "should", "would",

"could", "via", "may".

  • [ ] Use Oxford comma and American spelling.

4. Check style of headings

  • [ ] Use Sentence case for headings.
  • If you change a heading, add an id after the heading like this:

"## Configure the project {: #project-configuration }"

  • [ ] Put a blank line after all headings.

5. Check style of lists

  • [ ] Numbered lists MUST use 1. for every item to allow easy reordering.
  • [ ] How-to sections must have active voice in headings.
  • No: "## Project Configuration"
  • Yes: "## Configure the project"

6. Use less words in sections with steps

  • [ ] Ask the user if they would like the steps to be more concise.

If yes, update the steps to be brief. Keep it short, simple, and accurate.

Related skills

This week in AI coding

Five minutes, every Monday - the tools, releases and tactics for developers.

unsubscribe anytime.