good-docs-writing

Writes and revises technical documentation in a direct, second-person, example-first style.

30.0k|4.8k|Updated Feb 23, 2024
One-click install
npx skills add https://github.com/ComposioHQ/composio --skill good-docs-writing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: good-docs-writing
Source: https://github.com/ComposioHQ/composio/tree/main/.agents/skills/good-docs-writing
Command: npx skills add https://github.com/ComposioHQ/composio --skill good-docs-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Technical docs often read as vague, jargon-heavy, or marketing-flavored prose that buries the useful information. This Skill enforces a concrete style guide derived from Modal's documentation voice so drafts and revisions come out direct, confident, and example-first.

Core Features & Use Cases

  • Style-guided drafting: Write new docs, guides, and tutorials following rules for voice, structure, terminology, punctuation, code examples, and formatting.
  • Prose revision: Rewrite existing documentation toward second-person address, minimal jargon, no em-dashes, and backticked code identifiers.
  • Full rule reference: Consult references/style-guide.md for the complete rule set with real examples as evidence.
  • Use Case: You draft a getting-started guide for your SDK and want it to read like Modal's docs: open with the concept, show a runnable example early, address the reader as "you", and cut vague intensifiers like "seamlessly".

Quick Start

Ask the assistant to draft or rewrite a documentation page using the good-docs-writing style guide, for example: "Rewrite this tutorial intro in the Modal docs voice."

Frequently Asked Questions about good-docs-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write developer documentation in Modal's style?

Apply the rules in references/style-guide.md: address the reader as "you", open with the concept or benefit, place a minimal runnable example near the top, and explain what just happened. Cut vague intensifiers and backtick every code identifier.

How to revise existing docs to be more direct and less jargon-heavy?

Run the prose against the style guide's checklist: replace "the user" with "you", remove em-dashes, delete words like "seamlessly" and "powerful", and restructure so a runnable example appears before deep explanation.

What writing rules does this style guide enforce?

It covers six areas: voice and tone, structure, terminology, punctuation, code examples, and formatting. Hard rules include no em-dashes, Oxford commas, backticked code identifiers, and capitalized product nouns like App and Function.

Can I use this to review docs instead of drafting new ones?

Yes. The SKILL.md notes that reviewing existing prose against the same rules is handled by a companion skill called good-docs-audit, while this skill focuses on drafting and revising toward the target voice.

When is this documentation style not a good fit?

It targets developer-facing docs, guides, and tutorials. It is not designed for marketing copy, legal text, or API reference generated from schemas, where different conventions and tones apply.