Documentation collapse anti-patterns - detection rules, bad examples, and remediation strategies for type-mixing violations
From nwnpx claudepluginhub nwave-ai/nwave --plugin nwThis skill uses the workspace's default tool permissions.
Documentation collapse = types merge inappropriately, serving no audience well.
Description: Tutorial explains "why" extensively | Detection: explanation >20% | Fix: extract to separate doc, link back
Description: How-to teaches basics first | Detection: teaching fundamentals before steps | Fix: link to tutorial, assume baseline
Description: Reference includes conversational prose | Detection: prose paragraphs in entries | Fix: move to explanation doc, keep factual
Description: Explanation ends with "do this" steps | Detection: step-by-step in explanation | Fix: move steps to how-to, link
Description: Single doc tries all four types | Detection: 3+ quadrants in one doc | Fix: split with clear boundaries
Flag collapse when:
20% content from adjacent quadrant | Two user needs served simultaneously | Ambiguous user journey stage
# Getting Started
If you need to deploy to production, follow these steps...
Problem: Assumes user knows what "deploy to production" means. A tutorial should assume nothing.
# How to Configure Authentication
First, let's understand what authentication is. Authentication is...
Problem: Should assume user knows what authentication is. Link to a tutorial instead.
## login(username, password)
This is probably the most important function you'll use...
Problem: Reference should be factual, not opinionated. Remove "probably the most important" editorializing.
# Why We Use Microservices
... therefore, you should: 1. Create a service, 2. Deploy it...
Problem: Steps belong in a how-to guide. The explanation should end with reasoning and link to the how-to for action.