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.
How do I install this agent skill?
npx skills add https://github.com/composiohq/composio --skill good-docs-writingIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill provides a style guide for technical documentation, focusing on a direct, example-first voice. It contains no code and is safe, though it processes user-provided text which is an inherent surface for indirect prompt injection.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
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.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/composiohq/composio/good-docs-writing">View good-docs-writing on skillZs</a>