SkillAgentSearch skills...

nw-document

Creates evidence-based documentation following DIVIO/Diataxis principles

Install / Use

npx skills add nWave-ai/nWave --skill nw-document

Installs into whichever agent you are using.

About this skill
📄

SKILL.md

Installable skill definition

Quality Score

84/100

Supported Platforms

Universal

Our assessment of nw-document

nw-document scores 84/100 on our quality scale, 885th of 1,156 Content & Media skills we index.

Its SKILL.md is 5.5 KB long, well organised into 19 sections with 5 code examples: a solid amount of guidance for an agent.

It has 617 GitHub stars, a meaningful sign that others use it.

Substance
26/30
Structure
20/20
Description
12/15
Adoption
12/20
Freshness
15/15

Maintenance, license and trust

  • The repository was last updated about 2 months ago, so nw-document is actively maintained.
  • Our last check on 2026-11-06 found the source still online.
  • It is released under the MIT license, a permissive license that allows use, modification and commercial use with attribution.
  • Its trust signals score 100/100, with no cautions. These come from repository metadata, not a code audit — read the skill file before letting an agent act on it.

Safety scan

No issues found

Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful.

AI review by kimi-k2.7-code on 2026-10-08. Automated pattern scan on 2026-10-08. It catches known dangerous patterns, not every risk — read a skill before letting an agent act on it.

nw-document compared with similar skills

All 4 of these similar skills score higher than nw-document; compare them before choosing.

SkillScoreStarsUpdatedFormat
nw-document (this skill)by nWave-ai846172mo agoSKILL.md
siyuanby siyuan-note10047.3ktodayMCP Server
x402by browser-use100121.0k4d agoSKILL.md
algorithmic-artby anthropics100177.9k56d agoSKILL.md
pptxby anthropics100177.9k56d agoSKILL.md

Frequently asked questions

How do I install nw-document?
Run npx skills add nWave-ai/nWave --skill nw-document. The install tabs above show the steps for each supported agent.
Which AI agents does nw-document work with?
It is written for Universal, as a SKILL.md file. Other agents that read the same format can often use it too.
Is nw-document safe to use?
Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful. It is MIT-licensed and scores 100/100 on trust signals. Skills are instructions an agent will follow, so read the file before installing it and do not approve commands you do not understand.
Is nw-document still maintained?
The repository was last updated about 2 months ago, so nw-document is actively maintained.

name: nw-document description: "Creates evidence-based documentation following DIVIO/Diataxis principles. Use when writing tutorials, how-to guides, reference docs, or explanations." user-invocable: true argument-hint: '[topic/component] - Optional: --type=[tutorial|howto|reference|explanation] --research-depth=[overview|detailed|comprehensive|deep-dive]'

NW-DOCUMENT: DIVIO Documentation Creation

Wave: CROSS_WAVE | Agent: Orchestrator (self) Agents: Nova (nw-researcher)|Scholar (nw-researcher-reviewer)|Quill (nw-documentarist)|nw-documentarist-reviewer

Overview

Create evidence-based, DIVIO-compliant documentation by orchestrating research and writing phases with peer review at each gate. Cross-wave capability for any nWave phase.

Context Files Required

  • .nwave/trusted-source-domains.yaml — Embed inline in researcher prompt
  • ~/.claude/agents/nw/nw-researcher.md — Extract research methodology
  • ~/.claude/agents/nw/nw-documentarist.md — Extract DIVIO framework and templates

Command Syntax

/nw-document [topic] [--type=tutorial|howto|reference|explanation] [--research-depth=overview|detailed|comprehensive|deep-dive]

If --type omitted, ask user. If --research-depth omitted, auto-select: tutorial->overview|howto->detailed|reference->comprehensive|explanation->deep-dive.

Orchestration Phases

Sub-agents have no Skill tool access. Embed all domain knowledge inline in each Task prompt. Read from agent files and config at orchestration time.

Phase 1: Research           @nw-researcher
Phase 1.5: Research Review  @nw-researcher-reviewer
Phase 2: Documentation      @nw-documentarist
Phase 2.5: Doc Review       @nw-documentarist-reviewer
Phase 3: Handoff

Phase 0: Pre-Flight

  1. Validate topic non-empty, type/depth valid if provided
  2. If type not specified, present DIVIO selection: TUTORIAL ("Teach me")|HOW-TO ("Help me do X")|REFERENCE ("What is X?")|EXPLANATION ("Why is X?")
  3. Determine output: docs/{tutorials|howto|reference|explanation}/{topic-kebab-case}.md
  4. Read and cache: .nwave/trusted-source-domains.yaml|nw-researcher.md|nw-documentarist.md

Phase 1: Research (@nw-researcher)

Invoke via Task tool. Prompt includes: topic|doc type|research depth|complete .nwave/trusted-source-domains.yaml (inline)|type-specific research focus (from nw-researcher.md)|quality gates: trusted sources only, 3+ sources/claim, citation coverage >95%, source reputation >=0.80. Output: docs/research/{topic-kebab-case}-for-{type}-doc.md

Phase 1.5: Research Review (@nw-researcher-reviewer)

Prompt includes: research artifact path|review focus (source verification|bias detection|evidence quality|cross-reference|doc readiness)|quality gates (same as Phase 1)|output: append YAML review metadata. Verdicts: APPROVED|NEEDS_REVISION|REJECTED

Phase 2: Documentation (@nw-documentarist)

Prompt includes: topic|type|research path|DIVIO framework principles (from nw-documentarist.md)|type-specific validation rules + template|collapse detection anti-patterns|quality gates: type purity >=80%, Flesch 70-80, zero spelling errors, zero broken links, style >=95%. Output: doc file + .validation.yaml

Phase 2.5: Documentation Review (@nw-documentarist-reviewer)

Prompt includes: doc artifact path|review focus (classification accuracy|validation completeness|collapse detection|recommendation quality|scores|verdict)|quality gates (same as Phase 2)|output: append YAML review metadata. Verdicts: APPROVED|NEEDS_REVISION|RESTRUCTURE_REQUIRED

Phase 3: Handoff

Verify all deliverables exist and both reviews APPROVED. Present: research path|doc path|validation path|quality gate results|review outcomes and iteration count.

Review Iteration Protocol

Applies to both review gates (Phase 1.5 and 2.5):

  1. APPROVED: Proceed to next phase
  2. NEEDS_REVISION: Extract critiques, re-invoke producer with feedback, re-invoke reviewer. Max 2 cycles. Escalate to user after 2 failures.
  3. REJECTED / RESTRUCTURE_REQUIRED: Escalate immediately — restart|adjust scope|accept with issues|cancel.

Examples

Example 1: Tutorial with auto-depth

/nw-document "Getting Started with nWave" --type=tutorial

Orchestrator auto-selects overview depth, invokes researcher, reviews, invokes documentarist, reviews, outputs to docs/tutorials/getting-started-with-nwave.md.

Example 2: Explanation with explicit depth

/nw-document "Why nWave Uses Hexagonal Architecture" --type=explanation --research-depth=deep-dive

Full 4-phase pipeline with deep-dive research. Output to docs/explanation/.

Example 3: Interactive type selection

/nw-document "Mikado Method Integration"

Orchestrator prompts user to select DIVIO type before proceeding.

Success Criteria

  • [ ] Research created with trusted sources and cross-references
  • [ ] Research review: APPROVED (max 2 cycles)
  • [ ] Documentation follows DIVIO template with >=80% type purity
  • [ ] Doc review: APPROVED (max 2 cycles)
  • [ ] All deliverables exist: research|documentation|validation report
  • [ ] No collapse anti-patterns detected

Error Handling

  • Insufficient sources: continue with gaps|expand scope|cancel
  • Review iteration limit exceeded: escalate with persistent issues
  • Collapse detected: split into separate docs|revise scope|accept

Next Wave

Handoff To: Invoking workflow Deliverables:

  • Research: docs/research/{topic}-for-{type}-doc.md
  • Documentation: docs/{type-dir}/{topic-kebab-case}.md
  • Validation: docs/{type-dir}/{topic-kebab-case}.md.validation.yaml

Related Skills

View on GitHub
GitHub Stars617
CategoryContent
Updated2mo ago
Forks63

Languages

Python

Trust signals

100/100

From repository metadata: license, adoption, age and documentation. Not a code audit — see the Safety scan above for what the skill file itself contains.

No cautions