writing-standards

What problem does it solve?

Inconsistent, unclear, or verbose technical writing wastes time, causes misunderstandings, and slows down development cycles. This Skill provides a comprehensive guide to ensure all technical communication is concise, clear, and effective, allowing teams to collaborate more efficiently.

Core Features & Use Cases

• Standardized Documentation: Apply consistent rules for READMEs, docstrings (PEP 257), and inline comments, making codebases easier to understand and maintain for everyone.
• Effective Communication: Craft clear commit messages (conventional commits), PR descriptions, and user-facing error messages that convey information efficiently, reducing back-and-forth.
• Review Checklist: Use a built-in checklist to quickly review any technical text, ensuring it meets quality standards before publication and saving valuable review cycles.
• Use Case: Before submitting a Pull Request, use this Skill to review your commit messages, PR description, and new code's docstrings to ensure they meet project standards, saving review cycles and improving collaboration.

Quick Start

Use the writing-standards skill to review the attached pull request description for clarity, conciseness, and adherence to conventional commit standards.