guidelines-advisor

The `guidelines-advisor` skill is a specialized tool designed to assist developers in evaluating and improving smart contract codebases. It addresses the challenges of maintaining secure, well-documented, and efficient smart contracts by providing systematic guidance based on Trail of Bits' best practices. The skill helps teams identify architectural weaknesses, implementation pitfalls, dependency risks, and testing gaps, ensuring that smart contracts are robust, maintainable, and aligned with industry standards.

This skill offers a range of capabilities, including generating plain English documentation and specifications, creating architectural diagrams, reviewing upgradeability patterns and proxy implementations, and assessing function composition, inheritance structures, and event logging. It also evaluates testing coverage, dependency quality, and platform-specific considerations like compiler warnings or Solidity version recommendations. Each analysis phase—from discovery and documentation generation to architecture review and actionable recommendations—is designed to provide comprehensive insights and prioritized improvement suggestions.

`guidelines-advisor` is particularly useful for smart contract developers, auditors, and project teams seeking to enhance code quality, security, and maintainability. It can be applied during development to guide best practices, prior to audits to identify potential issues, or for educational purposes to train developers on secure smart contract patterns. The skill targets users working with Solidity and other smart contract platforms, helping them optimize both on-chain and off-chain components while mitigating common vulnerabilities.