technical-writing

Enforce Google's technical-writing guidelines for tutorials, API docs, and system documentation.

5|3|Updated Nov 5, 2025
One-click install
npx skills add https://github.com/chekos/bns-marketplace --skill technical-writing-chekos
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/chekos/bns-marketplace/tree/main/tdd-tech/skills/technical-writing
Command: npx skills add https://github.com/chekos/bns-marketplace --skill technical-writing-chekos

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Solves unclear and verbose technical communication by enforcing Google's technical-writing guidelines.

Core Features & Use Cases

  • Clear writing guidelines for technical content
  • Structured formats that improve scanability (headings, bullets, steps)
  • Practical tutorials and documentation patterns (inline code examples, emphasis on audience)

Quick Start

Draft a short tutorial that explains a technical concept to a beginner audience using clear sentences, active voice, descriptive headings, and a step-by-step sequence.

Frequently Asked Questions about technical-writing

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

FAQPage Schema
How do I write technical documentation that is clear and easy to scan?

Clear technical documentation uses concise language, active voice, and structured formatting like headings and bullets to enforce readability. It guides content from concept to implementation by applying audience-aware explanations.

What are the best guidelines for writing tutorials for a beginner audience?

The best guidelines for tutorials enforce descriptive headings, active voice, and step-by-step sequences. Drafting with clear sentences and inline code examples ensures the beginner audience understands the technical concept.

How does active voice improve API docs and system documentation?

Active voice improves API docs and system documentation by enforcing concise language and direct explanations. This audience-aware approach solves unclear and verbose technical communication across software projects.

Can I use this to turn rough ideas into structured software project documentation?

Yes, you can turn ideas into actionable docs by enforcing structured formats and practical documentation patterns. It guides content from concept to implementation across tutorials and system documentation.

When should I avoid using verbose language in technical communication?

You should avoid verbose language in technical communication whenever drafting software project tutorials or API docs. Enforcing concise language and structured formatting ensures your system documentation achieves maximum readability.