good-docs-writing
Writing style guide derived from Modal's documentation voice. Apply when writing or editing docs, guides, tutorials, or technical prose that should read direct, second-person, confident, low-jargon, and example-first. Use to draft new docs in this voice or to revise existing prose toward it.
70
86%
Does it follow best practices?
Run evals on this skill
Adds up to 20 points to the overall score
View guide
Passed
No findings from the security scan
Good docs writing
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.
- Repository
- ComposioHQ/composio
- Commit
7a63e5a
- Last updated
- First committed
Is this your skill?
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.