tech-writing-style

What problem does it solve?

This Skill eliminates inconsistent, hard-to-follow technical writing that wastes engineering time, creates confusion during implementation, and leads to outdated or unreliable documentation across engineering-facing content.

Core Features & Use Cases

• Universal Style Guide for Engineering Docs: Applies to all engineering-facing prose including READMEs, architecture overviews, API references, runbooks, ADRs, design docs, PRDs, code comments, and onboarding guides for both writing and editing tasks.
• Clarity & Conciseness Rules: Enforces active voice, imperative mood for instructions, concrete real-world examples over abstract claims, no filler words, no marketing fluff, and consistent terminology to reduce reader skimming and confusion.
• Verifiability & Quality Guardrails: Requires citations for all concrete claims, discourages unsubstantiated hedge words, and includes a final pre-delivery checklist to catch errors, inconsistencies, and style violations before publishing.
• Use Case Example: When a developer writes a new API reference, this Skill ensures all endpoint descriptions use active voice, include real request/response code examples, cite the source code location, and avoid vague language like "typically works" so other team members can implement integrations quickly without follow-up questions.

Quick Start

Use the tech-writing-style skill to edit the draft API reference document to enforce active voice, add concrete request/response examples, and remove all marketing fluff and unsubstantiated claims before publishing.