Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

next
md 21 lines 1.38 KB
Rendered Raw
1 ---
2 name: good-docs-writing
3 description: 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.
4 ---
5
6 # Good docs writing
7
8 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.
9
10 Read `references/style-guide.md` for the full rule set (Voice, Structure, Terminology, Punctuation, Code examples, Formatting) and apply every rule while drafting.
11
12 The rules that matter most, before you open the reference:
13
14 - Address the reader as "you", never "the user" or "one".
15 - Open with the concept or benefit in the first sentence. No throat-clearing.
16 - Put a minimal runnable example near the top, then explain what just happened.
17 - Remove every em-dash. Use a period, comma, colon, or parentheses instead.
18 - Cut vague intensifiers ("seamlessly", "powerful", "robust", "cutting-edge"). Show a thing being easy instead of calling it easy.
19 - Backtick every code identifier, command, parameter, path, and filename.
20
21 To review existing prose against these rules instead of drafting, use `good-docs-audit`.