Index of every page on this site: llms.txt
All skills
composiohq avatar

/good-docs-writing

@85dab73
by Composiocomposiohq/composio31k stars
4,962
Run it yourself

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.

Use this Skill: https://skilld.dev/gh/composiohq/composio/good-docs-writing

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈78 tokens for metadata: the name and description. ≈270 when used: this file. ≈1.4k more on demand in 1 file.

Description uses 3.9% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈312 characters, or 3.9%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts2d3 checks · Risk SAFE
  • Gen Agent Trust Hub2d

    This skill is a collection of natural language instructions and style guidelines for writing documentation. It contains no executable code, network operations, or sensitive data access.

  • Socket3mo

    No alerts

  • Snyk2d

    Risk: LOW · No issues

Signed by skilld at 85dab73. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 4 months ago

README badge

README badge for composiohq/composio/good-docs-writing