crane-natspec

Document Solidity contracts with NatSpec and AsciiDoc include-tags.

Updated Jan 22, 2026

Search Tags:#documentation #solidity #tags #smart-contracts #selectors #asciidoc #natspec

Ready to run

npx skills add https://github.com/cyotee/cyotee-claude-plugin-crane --skill crane-natspec

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: crane-natspec
Source: https://github.com/cyotee/cyotee-claude-plugin-crane/tree/main/.opencode/skills/crane-natspec
Command: npx skills add https://github.com/cyotee/cyotee-claude-plugin-crane --skill crane-natspec

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

NatSpec and AsciiDoc include-tags enable structured, extractable documentation for Solidity contracts, but teams often struggle with consistent tagging and cross-referencing.

Core Features & Use Cases

Standardized NatSpec tagging for functions, errors, events, and interfaces.
AsciiDoc include-tags to facilitate modular documentation extraction.
Guidance, examples, and validation patterns for canonical and custom tags.

Quick Start

Annotate a Solidity function with NatSpec and include-tags to generate ready-to-publish documentation.

Frequently Asked Questions about crane-natspec

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

FAQPage Schema

How do I generate NatSpec documentation for Solidity smart contracts?▼

Document Solidity smart contracts with NatSpec by applying standardized tagging patterns to functions, errors, events, and interfaces. This enforces correct tagging and provides structured, machine-readable documentation.

Can I use AsciiDoc include-tags to extract modular Solidity documentation?▼

Yes, you can use AsciiDoc include-tags to extract modular Solidity documentation. This approach enables structured cross-referencing and extraction across projects requiring consistent, machine-readable contract documentation.

What is the best way to enforce consistent NatSpec tagging across multiple smart contracts?▼

The best way to enforce consistent NatSpec tagging is to apply validation patterns and standardized tags for functions, errors, events, and interfaces. This ensures consistent cross-referencing and resolves team tagging inconsistencies.

Does NatSpec support custom tags for smart contract events and errors?▼

Yes, NatSpec supports custom tags alongside canonical tags for smart contract events, errors, and interfaces. You can use provided validation patterns and examples to generate and verify both standard and custom tag formats.

When do I need AsciiDoc include-tags for Solidity documentation?▼

You need AsciiDoc include-tags for Solidity documentation when you want to enable structured, extractable documentation across multiple projects. This is useful when annotating contracts for consistent, machine-readable extraction.