core-technical-writing

What problem does it solve?

This Skill addresses the challenge of creating and maintaining clear, precise technical documentation, crucial for project consistency and understanding.

Core Features & Use Cases

• Technical Documentation Doctrine: Offers guidelines for structure, voice, and vocabulary in documentation.
• Format Conventions: Provides format standards for various document types like READMEs, ADRs, CHANGELOGs, etc.
• Anti-Patterns: Identifies and prevents common issues that degrade clarity.
• Examples: Includes WRONG/CORRECT examples across different document types for better understanding.
• Use Case: Use this Skill when authoring or reviewing any technical documentation artifact, from inline comments to public API references.

Quick Start

Apply the core-technical-writing skill to your project documentation to ensure adherence to technical writing standards.