writing

What problem does it solve?

This Skill provides comprehensive guidelines for clear, concise, and effective technical writing, ensuring all documentation, comments, and communications are easy to understand. It reduces ambiguity, improves team collaboration, and saves time spent clarifying poorly written content.

Core Features & Use Cases

• Core Principles: Emphasizes conciseness, active voice, leading with results, and using one idea per sentence for maximum clarity and impact.
• Documentation Standards: Guides on structuring READMEs, writing effective code comments (explaining why, not what), and crafting clear, imperative commit messages.
• Technical Communication: Provides best practices for error messages (What happened. What to do.), API documentation, and general technical prose, ensuring professionalism and helpfulness.
• Use Case: Draft a README file for a new open-source project. Use this Skill to ensure it's concise, leads with results, clearly explains how to use the project, and is accessible to new users, reducing their onboarding time.

Quick Start

Using the writing skill, draft a concise commit message for a change that fixed a payment validation error, ensuring it follows the imperative mood and is specific.