writing-style-guide
Writing Style Guide
Overview
Words that ship — documentation, commits, PRs, changelogs, and chat replies — are part of the deliverable. This skill sets writing principles, not a procedure: apply judgment, preserve contracts, and make every word earn its place.
Scope
Apply when producing or editing:
- Comments, docstrings, README, CHANGELOG, and narrative docs
- Commit messages, PR descriptions, release notes, and chat replies
Skip when text is internal, verbatim tool/log output, transient progress text, or a bare acknowledgment is the whole reply.
If output must match an exact format, that format wins. JSON, protocol payloads, parser-sensitive templates, and other machine-readable shapes must keep their required structure and receive no extra prose or Markdown fences. Human-readable comments/docstrings remain in scope.
Core Principles
More from adhi-jp/agent-skills
review-scope-guard
Use when Codex or code/plan review findings need Definition-of-Done scope triage, especially to separate must-fix issues from minimal hygiene, out-of-scope hardening, repeated noise, or self-induced refinements. Also use when codex-review-cycle invokes scope guard between validity checking and summary render. Do not use for single-shot lint or unrelated changes.
34codex-review-cycle
Use when the user explicitly asks to run an iterative Codex review cycle on a non-empty git diff, including working-tree changes, current branch vs base, explicit commit/tag/branch refs, code diffs, or Markdown planning documents. Do not use for one-shot reviews, auto-hardening, background checks, plan drafting, or empty review targets.
34minecraft-modding-workbench
>
22review-fix-cascade-guard
Use when applying user-selected review findings after scope triage, especially inside codex-review-cycle or after a standalone Codex adversarial review, and a line-scoped fix may create follow-on valid findings. Do not use for ordinary edits, plan drafting, single-shot lint, no-review contexts, or generic refactor checklists.
19vibe-planning
>
17vibe-plan-execution
Use when the user asks to execute, implement, continue, or apply an existing implementation plan, specification, acceptance criteria, task plan, or vibe-planning output. Do not use for plan creation or coding requests with no concrete plan to bind.
17