prose-style-review

name	prose-style-review
description	Review hsquared README, design docs, vignettes, issue text, and release prose for reader-first, concrete, honest wording. Use when public or long-form prose changes.

Prose Style Review

Procedure

1. Name the reader: breeder, evolutionary biologist, ecologist, applied PhD user, method developer, or package contributor.
2. Put purpose before mechanics.
3. Separate implemented, partial, planned, and missing capabilities.
4. Pair syntax, equations, and interpretation when explaining models.
5. Replace vague claims with evidence, citations, or explicit design assumptions.
6. Give users a next step when syntax is unsupported.

Rose Check

If prose says fits, estimates, supports, fast, or ASReml-level, it needs local evidence or softer wording.