nw-collapse-detection

Documentation collapse anti-patterns - detection rules, bad examples, and remediation strategies for type-mixing violations

322 stars

Best use case

nw-collapse-detection is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Documentation collapse anti-patterns - detection rules, bad examples, and remediation strategies for type-mixing violations

Teams using nw-collapse-detection should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/nw-collapse-detection/SKILL.md --create-dirs "https://raw.githubusercontent.com/nWave-ai/nWave/main/nWave/skills/nw-collapse-detection/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/nw-collapse-detection/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How nw-collapse-detection Compares

Feature / Agentnw-collapse-detectionStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Documentation collapse anti-patterns - detection rules, bad examples, and remediation strategies for type-mixing violations

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# 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

### Hybrid Horror
Description: Single doc tries all four types | Detection: 3+ quadrants in one doc | Fix: split with clear boundaries

## Detection Rules

Flag collapse when:
- >20% content from adjacent quadrant | Two user needs served simultaneously | Ambiguous user journey stage
- "Why" in tutorials | Task steps in explanations | Teaching in how-tos | Narrative in references

## Bad Examples for Calibration

### Tutorial with Task Focus
```markdown
# 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 Teaching Basics
```markdown
# 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.

### Reference with Opinions
```markdown
## 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.

### Explanation with Steps
```markdown
# 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.

Related Skills

nw-ux-web-patterns

322
from nWave-ai/nWave

Web UI design patterns for product owners. Load when designing web application interfaces, writing web-specific acceptance criteria, or evaluating responsive designs.

nw-ux-tui-patterns

322
from nWave-ai/nWave

Terminal UI and CLI design patterns for product owners. Load when designing command-line tools, interactive terminal applications, or writing CLI-specific acceptance criteria.

nw-ux-principles

322
from nWave-ai/nWave

Core UX principles for product owners. Load when evaluating interface designs, writing acceptance criteria with UX requirements, or reviewing wireframes and mockups.

nw-ux-emotional-design

322
from nWave-ai/nWave

Emotional design and delight patterns for product owners. Load when designing onboarding flows, empty states, first-run experiences, or evaluating the emotional quality of an interface.

nw-ux-desktop-patterns

322
from nWave-ai/nWave

Desktop application UI patterns for product owners. Load when designing native or cross-platform desktop applications, writing desktop-specific acceptance criteria, or evaluating panel layouts and keyboard workflows.

nw-user-story-mapping

322
from nWave-ai/nWave

User story mapping for backlog management and outcome-based prioritization. Load during Phase 2.5 (User Story Mapping) to produce story-map.md and prioritization.md.

nw-tr-review-criteria

322
from nWave-ai/nWave

Review dimensions and scoring for root cause analysis quality assessment

nw-tlaplus-verification

322
from nWave-ai/nWave

TLA+ formal verification for design correctness and PBT pipeline integration

nw-test-refactoring-catalog

322
from nWave-ai/nWave

Detailed refactoring mechanics with step-by-step procedures, and test code smell catalog with detection patterns and before/after examples

nw-test-organization-conventions

322
from nWave-ai/nWave

Test directory structure patterns by architecture style, language conventions, naming rules, and fixture placement. Decision tree for selecting test organization strategy.

nw-test-design-mandates

322
from nWave-ai/nWave

Four design mandates for acceptance tests - hexagonal boundary enforcement, business language abstraction, user journey completeness, walking skeleton strategy, and pure function extraction

nw-tdd-review-enforcement

322
from nWave-ai/nWave

Test design mandate enforcement, test budget validation, 5-phase TDD validation, and external validity checks for the software crafter reviewer