Documentation
README
Collapse Detection
Documentation collapse = types merge inappropriately, serving no audience well.
Anti-Patterns
Tutorial Creep
Description: Tutorial explains "why" extensively | Detection: explanation >20% | Fix: extract to separate doc, link back
How-to Bloat
Description: How-to teaches basics first | Detection: teaching fundamentals before steps | Fix: link to tutorial, assume baseline
Reference Narrative
Description: Reference includes conversational prose | Detection: prose paragraphs in entries | Fix: move to explanation doc, keep factual
Explanation Task Drift
Description: Explanation ends with "do this" steps | Detection: step-by-step in explanation | Fix: move steps to how-to, link
This is the opening of the README. Read the full README on GitHub.