nw-collapse-detection
Documentation collapse anti-patterns - detection rules, bad examples, and remediation strategies for type-mixing violations
它会碰到什么
这一栏是扫描器报的事实,不是结论。命中多不等于有毒(安全工具、规则库、示例脚本本来就会包含危险写法),命中少也不等于干净。它和你手上的凭据、文件、网络有什么关系,需要你自己看。
技能内容
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
# 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
# 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
## 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
# 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.
想直接用这个技能?
本站把开放许可(MIT / Apache 等)的技能按仓库打包整理到网盘,点一下转存到你自己的网盘,不用一个个从 GitHub 拉。许可未声明的技能只给原始仓库链接,不打包。
同名技能的其他版本
有 2 个不同仓库或目录里都有叫 nw-collapse-detection 的技能。它们内容并不相同,别混用:
- nWave-ai/nWave — Documentation collapse anti-patterns - detection rules, bad examples, and remediation stra