tech-writer

Rewrite software documentation prose with active voice and structured frameworks.

88|9|Updated Jul 16, 2020
One-click install
npx skills add https://github.com/docs-plus/docs.plus --skill tech-writer-docs-plus
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tech-writer
Source: https://github.com/docs-plus/docs.plus/tree/main/.cursor/skills/tech-writer
Command: npx skills add https://github.com/docs-plus/docs.plus --skill tech-writer-docs-plus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates inconsistent, verbose, or poorly structured technical documentation that wastes reader time and fails to convey critical information clearly for software projects.

Core Features & Use Cases

  • Consistent Technical Writer Voice: Applies senior-level technical writing rules to all prose documentation tasks, including READMEs, CHANGELOGs, runbooks, design docs/ADRs, post-mortems, PR descriptions, and code comment prose.
  • Structured Document Frameworks: Provides pre-built, reader-intent document spines for common document types to ensure logical flow without unnecessary sections.
  • Automated Constraint Enforcement: Automatically strips throat-clearing, marketing jargon, hedges, and redundant content to produce concise, actionable content.
  • Use Case: When you need to rewrite a rambling, 2-page README for an open source library to be concise and actionable for new contributors, this Skill applies consistent technical writing rules to produce clear, reader-focused content in minutes.

Quick Start

Use the tech-writer skill to rewrite the existing project README to lead with key installation and usage steps for new developers, following all senior technical writer constraints.

Frequently Asked Questions about tech-writer

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

FAQPage Schema
How do I rewrite a verbose README to be clear and actionable for new developers?

To rewrite a verbose README, apply strict technical writing constraints like active voice, present tense, and reader-intent structure. This strips throat-clearing and marketing jargon, producing concise, actionable content that leads with key installation and usage steps.

What is the best way to enforce consistent technical writing rules across project documentation?

Enforcing consistent technical writing rules across project documentation requires applying a senior writer voice to all prose tasks. This eliminates inconsistent prose across READMEs, runbooks, and design docs by automatically stripping hedges, marketing jargon, and redundant content.

Can I use automated prose editing to structure Architecture Decision Records and post-mortems?

Yes, automated prose editing can structure Architecture Decision Records and post-mortems by applying pre-built, reader-intent document spines. This ensures logical flow without unnecessary sections, keeping technical content focused and actionable.

Does active voice and present tense formatting work for code comment prose and PR descriptions?

Active voice and present tense formatting works for code comment prose and PR descriptions by enforcing strict writing constraints. It eliminates unclear technical prose, ensuring all software project documentation remains concise and directly communicates intent to reviewers.

When do I need to strip marketing jargon and hedges from technical runbooks?

You need to strip marketing jargon and hedges from technical runbooks when documentation becomes verbose and fails to convey critical information clearly. Automated constraint enforcement removes this filler to produce concise, actionable content that saves reader time.

Why does my technical documentation fail to convey critical information clearly to readers?

Technical documentation fails to convey critical information clearly when it contains inconsistent, verbose, or poorly structured prose. Applying a structured document framework with reader-intent rules restructures the content to produce clear, actionable technical information.