How does this skill help with security audits?

It ensures all functions, errors, and states are documented with technical details (@dev) and user notices (@notice), which provides auditors with a clear specification to compare against the implementation.

Why should I use @notice vs @dev tags?

The @notice tag is intended for end-users and is often displayed in wallet interfaces during transaction signing, while the @dev tag is for developers to explain technical implementation details.

Does it support modern Solidity features like custom errors?

Absolutely. The skill provides specific patterns for documenting modern Solidity features including custom errors, events, modifiers, and inheritance via the @inheritdoc tag.

Can I use this with Hardhat or Foundry?

Yes, this skill includes specific guidance for generating documentation using automated tools like 'forge doc' for Foundry and 'hardhat-dodoc' for Hardhat projects.

What is NatSpec in Solidity?

NatSpec (Ethereum Natural Specification) is a standard for documenting smart contracts to generate human-readable descriptions for developers and end-users in Ethereum applications and wallets.

Solidity NatSpec Documentation Standards

Name: Solidity NatSpec Documentation Standards
Author: IvanTorresEdge

byIvanTorresEdge

0•

Aprendizaje y Documentación

Implements comprehensive NatSpec documentation standards and best practices for Ethereum smart contracts.

This skill empowers developers to create high-quality, human-readable documentation for Solidity smart contracts using the Ethereum Natural Specification (NatSpec) format. It provides structured guidance for documenting contracts, functions, events, state variables, errors, and modifiers, ensuring that codebases are audit-ready and user-friendly. By following these patterns, developers can automatically generate technical documentation and provide critical information to end-users through wallet interfaces, improving both the developer experience and protocol transparency.

Características Principales

01Comprehensive tag reference for @title, @author, @notice, @dev, @param, and @return

02Support for specialized documentation of custom errors, modifiers, and data structures

030 GitHub stars

04Integration guides for documentation generation tools like Foundry and Hardhat

05Standardized patterns for documenting complex functions, events, and state variables

06Best practices for ensuring public and external functions are properly described

Casos de Uso

01Standardizing documentation across a multi-contract Solidity project

02Generating public-facing API documentation for decentralized protocols

03Preparing smart contracts for professional security audits

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add ivantorresedge/molcajete.ai natspec-standards

For use in Claude.ai and ChatGPT

Download Skill