Writing

Write clear technical documentation, commit messages and PR descriptions. Use unslop for standalone prose when it is installed.

badmuriss c200798 1.2 KB Updated

File contents

Writing

Lead with the concrete change or problem and its effect. Include the context a reader needs to assess it, then explain the relevant evidence and limitations. Use plain language, active verbs and precise examples. Do not replace calibrated uncertainty with a confident claim. Scale structure and detail to the artifact.

For commits, use conventional format, such as fix: preserve pending work on resume. Do not name an agent or add a co-author trailer.

For PRs, explain the resulting behavior and how it was verified. Use the repository template when present. Omit conversational history and abandoned approaches unless they explain a tradeoff that matters to review.

For documentation, keep commands and capabilities accurate. Move conditional procedures to linked references when they distract from normal use. Do not impose a heading template, sentence length or arbitrary cutting quota.

Use unslop for requested authored prose when it is installed; otherwise write directly using the user's style and constraints. Do not invoke its rubric for ordinary technical responses or status updates.

badmuriss/my-llm-kit/tree/main/skills/writing commit c200798915

Frequently asked questions

npx skillmds@latest add badmuriss/writing