Technical writing

Enforce ventilated prose and concise writing standards in Markdown and AsciiDoc files.

3|1|Updated Jul 1, 2015
One-click install
npx skills add https://github.com/mkobit/dotfiles --skill technical-writing-mkobit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Technical writing
Source: https://github.com/mkobit/dotfiles/tree/main/src/dot_claude/skills/technical-writing
Command: npx skills add https://github.com/mkobit/dotfiles --skill technical-writing-mkobit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill enforces ventilated prose and concise technical writing standards when the user is writing or editing standalone documentation files (e.g., Markdown, AsciiDoc). It should not be used for code documentation or docstrings.

Core Features & Use Cases

  • Ventilated prose: Write one sentence per line and break lines at sentence endings to improve diff readability.
  • Sentence case titles: Use sentence case for all headers, capitalizing only the first word and proper nouns.
  • Concise writing: Be terse, omit needless words, and use active voice for self-documenting structure.
  • Output discipline: Do not wrap paragraphs; produce content strictly following the rules.

Quick Start

Use these guidelines when drafting standalone documentation to improve readability. For example, rewrite a paragraph so each sentence is on its own line and adjust headers to sentence case.

Frequently Asked Questions about Technical writing

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

FAQPage Schema
How do I write documentation with ventilated prose?

Ventilated prose means writing one sentence per line and breaking lines at sentence endings. This format improves diff readability and makes documentation easier to review. Apply this structure when composing standalone documentation files like Markdown or AsciiDoc.

What's the best way to format headers in technical documentation?

Use sentence case for all headers, capitalizing only the first word and proper nouns. This approach maintains consistency across your documentation and aligns with concise writing standards for self-documenting content.

How do I make technical writing more concise and readable?

Eliminate needless words, use active voice, and structure sentences for clarity. These techniques create self-documenting content that communicates intent directly, reducing reader friction in standalone documentation.

Can I apply ventilated prose standards to code documentation?

No, this Skill applies only to standalone documentation files like Markdown and AsciiDoc, not to code comments or docstrings. Use it when composing or editing separate documentation rather than inline code annotations.

Why should documentation follow one sentence per line?

One sentence per line enables readable diffs and clearer version control history. It also forces clarity in each sentence and makes standalone documentation easier to parse and maintain over time.