document-node

Generate document-node example JSON workflows from Workscript node source metadata.

Updated Jul 10, 2025
One-click install
npx skills add https://github.com/Narcis13/workscript --skill document-node
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-node
Source: https://github.com/Narcis13/workscript/tree/main/.claude/skills/document-node
Command: npx skills add https://github.com/Narcis13/workscript --skill document-node

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

document-node documentation generation for Workscript nodes, producing production-ready example workflows that illustrate correct usage and help developers quickly understand node behavior.

Core Features & Use Cases

  • Generate production-quality document-node.example.json files that demonstrate node usage for documentation, testing, and onboarding.
  • Read node source metadata (id, inputs, outputs, ai_hints) to craft accurate example workflows.
  • Provide realistic initial state and sequential feature demonstrations to cover common and edge cases.

Quick Start

Document a node by generating its example JSON from its source metadata.

Frequently Asked Questions about document-node

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

FAQPage Schema
How do I generate Workscript node documentation examples from source metadata?

Generate Workscript node documentation by reading the source file to extract metadata like id, inputs, outputs, and ai_hints, then executing logic to produce a canonical example JSON file demonstrating correct node usage.

What is the best way to create example workflows for testing workflow nodes?

Creating example workflows for testing workflow nodes involves generating a flat sequential workflow with realistic initialState and edge case coverage to accurately demonstrate node behavior in production scenarios.

Can I use document-node to produce usage scenarios for subagent documentation?

Yes, document-node produces usage scenarios for subagent documentation by reading node source metadata and generating production-ready example JSON files that illustrate correct Workscript node behavior for onboarding.

Does the generated example JSON include edge case coverage for workflow nodes?

The generated example JSON includes edge case coverage by executing logic against extracted node metadata to produce a flat sequential workflow with realistic initialState that demonstrates common and edge case scenarios.

What metadata is required to generate node documentation examples?

Generating node documentation examples requires reading source metadata including the node id, inputs, outputs, and ai_hints to craft accurate example JSON workflows demonstrating correct node behavior.