What problem does it solve?
Inconsistent writing in GitHub issues, pull requests, commit messages, and project documentation leads to lost context, unclear reasoning, and wasted reader time, slowing down collaboration and code review for software engineering teams.
Core Features & Use Cases
- Diataxis-aligned writing guidance: Maps content to the four reader need quadrants (explanation, tutorial, reference, how-to) to ensure every piece of writing serves its intended purpose, whether it's a short commit message or a full documentation page.
- Standard GitHub artefact templates: Provides a consistent section palette for issues and PRs (summary, context, root cause, decision rationale, etc.) so no critical context is missing for reviewers or future contributors.
- Cross-skill consistency: Used by all chalk-related skills (commit drafting, PR writing, docs tending) to maintain a uniform voice across all project communication and documentation.
- Use Case: A team using the chalk plugin to draft PRs can use this skill to ensure every PR includes clear context, tradeoff explanations, and test plans, reducing reviewer back-and-forth and onboarding time for new team members.
Quick Start
Invoke the voice skill when drafting GitHub issues, pull requests, commit messages, or project documentation to ensure your writing follows the project's standardized, reader-optimized structure and tone.