Good docs writing

SkillDocs & knowledge

This skill gives your AI a writing style guide drawn from Modal's documentation voice, so technical writing comes out direct, confident, and easy to follow. Once added, your AI can draft new docs, guides, and tutorials or revise existing prose so it reads clearly, keeps jargon low, and leads with examples.

Available today. Use it from your connected AI after setup.

After adding the skill, point your AI at a doc you want written or a page you want improved and ask it to apply the style. It works just as well for tightening up tutorials or guides you have already drafted.

Then ask your AI: use the Good docs writing skill

What your AI can do with it

  • Draft new docs, guides, and tutorials in a direct, second-person voice
  • Revise existing documentation so it reads confident and low on jargon
  • Rewrite technical explanations to lead with examples
  • Edit technical prose toward a clear, example-first style

What this skill tells your AI

The instructions your AI receives, as published by composiohq/composio in .agents/skills/good-docs-writing/SKILL.md and read by ahel’s review.

Write docs the way Modal writes them: direct, friendly, confident, and ruthlessly practical. Explain the why in one breath, then show working code. Treat the reader as a capable developer who wants to ship, not a student who needs a lecture.

Read references/style-guide.md for the full rule set (Voice, Structure, Terminology, Punctuation, Code examples, Formatting) and apply every rule while drafting.

The rules that matter most, before you open the reference:

  • Address the reader as "you", never "the user" or "one".
  • Open with the concept or benefit in the first sentence. No throat-clearing.
  • Put a minimal runnable example near the top, then explain what just happened.
  • Remove every em-dash. Use a period, comma, colon, or parentheses instead.
  • Cut vague intensifiers ("seamlessly", "powerful", "robust", "cutting-edge"). Show a thing being easy instead of calling it easy.
  • Backtick every code identifier, command, parameter, path, and filename.

To review existing prose against these rules instead of drafting, use good-docs-audit.

Signals

GitHub stars
30k
Forks
5k
Last commit
Sep 2026
Advanced
Catalog kind
skill
Gateway key
good-docs-writing
Source
github.com/composiohq/composio