domains / families / security / guidelines-advisor

guidelines-advisor

separate

Smart contract development advisor based on Trail of Bits' best practices. Analyzes codebase to generate documentation/specifications, review architecture, check upgradeability patterns, assess implementation quality, identify pitfalls, review dependencies, and evaluate testing. Use when asking whether a smart contract project follows development best practices, reviewing on-chain/off-chain split, upgradeability, or delegatecall proxy patterns against guidelines, or seeking recommendations on contract design, inheritance, events, documentation, dependencies, or test strategy.

When to use

• **Generate documentation and specifications** (plain English descriptions, architectural diagrams, code documentation)
• **Optimize on-chain/off-chain architecture** (only if applicable)
• **Review upgradeability patterns** (if your project has upgrades)
• **Check delegatecall/proxy implementations** (if present)
• **Assess implementation quality** (functions, inheritance, events)
• **Identify common pitfalls**
• **Review dependencies**
• **Evaluate test suite and suggest improvements**

Skill page

Source