nw-collapse-detection

Detect documentation collapse by identifying type-mixing across adjacent quadrants.

Updated Mar 18, 2024
One-click install
npx skills add https://github.com/v1bh0r/precise-ledger-pro --skill nw-collapse-detection-v1bh0r
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: nw-collapse-detection
Source: https://github.com/v1bh0r/precise-ledger-pro/tree/main/nWave/skills/nw-collapse-detection
Command: npx skills add https://github.com/v1bh0r/precise-ledger-pro --skill nw-collapse-detection-v1bh0r

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation collapse anti-patterns occur when content from adjacent audience quadrants is merged, causing confusion and audience misalignment. This skill helps identify and resolve these collapses, ensuring each document serves a clear audience.

Core Features & Use Cases

  • Detection Rules: Identify when more than 20% of content comes from an adjacent quadrant, or when a single doc serves multiple audiences, creating ambiguous user journeys.
  • Calibration & Bad Examples: Provide calibration examples (Tutorial vs Reference vs How-To) to illustrate boundaries and help teams split content appropriately.
  • Remediation Guidance: Offer concrete steps to split content into tutorials, how-tos, references, or explanations with clear distinctions.

Quick Start

Identify instances where content from adjacent quadrants appears in the same document and reorganize it into clearly separated sections: tutorials, how-tos, references, and explanations.

Frequently Asked Questions about nw-collapse-detection

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is documentation collapse and how does type-mixing affect content clarity?

Documentation collapse occurs when content from adjacent audience quadrants is merged, causing audience misalignment and confusion. Type-mixing across tutorials, how-tos, references, and explanations creates ambiguous user journeys that fail to serve any single reader effectively.

How do I detect and fix content type-mixing in technical documentation?

Detect type-mixing by identifying when more than 20% of content comes from an adjacent quadrant. Fix it by applying remediation strategies to split overlapping content into clearly separated tutorials, how-tos, references, or explanations with distinct boundaries.

When should I separate tutorials from reference documentation?

Separate tutorials from references when a single document serves multiple audiences or overlaps exceed the 20% threshold. Use calibration examples to identify boundary violations and reorganize content so each document type maintains a clear, distinct instructional purpose.

What are the best practices for structuring documentation to prevent audience misalignment?

Best practices involve establishing clear boundaries between tutorials, how-tos, references, and explanations. Apply explicit detection rules to flag overlaps, use bad-example calibration to illustrate boundaries, and implement remediation strategies to guide refactoring and maintain content governance.

Can I use documentation quadrant detection for existing content governance audits?

Yes, documentation quadrant detection supports content governance audits by flagging existing overlaps across adjacent quadrants. It identifies ambiguous user journeys and proposes concrete boundaries and remediation steps to refactor and clarify misaligned technical documentation.

Why does my documentation confuse readers and serve multiple audiences poorly?

Documentation confuses readers when content collapse anti-patterns merge adjacent audience quadrants. Type-mixing across tutorials, how-tos, references, and explanations creates ambiguous user journeys, causing each document to fail its intended audience's specific needs.