skills.rest
Superlend
SuperlendOFFICIAL
Explore all skills by this author →
Website𝕏@SuperlendHQGitHub

guidelines-advisor

Analyze Solidity codebases to generate documentation and prioritized remediation recommendations.

Updated Jul 10, 2025
Search Tags:#documentation#best-practices#analyze#Solidity#architecture-review#security-guidelines#upgradeability
One-click install
npx skills add https://github.com/Superlend/superloop-core-contracts --skill guidelines-advisor-superlend
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: guidelines-advisor
Source: https://github.com/Superlend/superloop-core-contracts/tree/main/.cursor/skills/building-secure-contracts/skills/guidelines-advisor
Command: npx skills add https://github.com/Superlend/superloop-core-contracts --skill guidelines-advisor-superlend

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Smart contract development teams often struggle to translate Trail of Bits' secure coding guidelines into concrete design reviews, architecture diagrams, and actionable remediation steps. Guidelines Advisor automates a thorough evaluation of a codebase against established best practices, producing clear documentation and recommendations.

Core Features & Use Cases

  • Documentation generation: Create plain-English system descriptions, architectural diagrams, and NatSpec-like documentation recommendations.
  • Architecture & review: Assess upgradeability patterns, proxy usage, inheritance, and event coverage to identify architectural risks.
  • Recommendations & remediation: Provide prioritized, actionable steps to improve security, quality, and test coverage.
  • Use Case: Run Guidelines Advisor on a new Solidity project to produce an assessment report aligned with Trail of Bits standards.

Quick Start

Use the guidelines-advisor skill to analyze a Solidity project and generate a thorough review and improvement plan.

Frequently Asked Questions about guidelines-advisor

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

FAQPage Schema
How do I generate documentation and security guidelines for a Solidity codebase?▼

You can analyze a Solidity codebase to generate plain-English documentation, architectural diagrams, architecture guidance, and actionable remediation steps aligned with secure coding best practices.

What is the best way to review upgradeability patterns and proxy usage in smart contracts?▼

Reviewing upgradeability patterns and proxy usage involves assessing inheritance, event coverage, and dependency analysis to identify architectural risks and produce prioritized remediation recommendations.

Can I assess Solidity test coverage and dependency risks using automated architecture review?▼

Yes, automated architecture review evaluates testing assessment and dependency scrutiny across multiple phases to identify risks and provide actionable steps to improve test coverage.

Does this smart contract guidelines advisor work for projects requiring complex dependency analysis?▼

Yes, the advisor evaluates contracts requiring upgradeability and dependency analysis, providing a thorough assessment report that satisfies architecture analysis and dependencies scrutiny requirements.

How do I get prioritized remediation steps after an architecture review of my Solidity project?▼

The analysis generates prioritized, actionable remediation recommendations by evaluating implementation review, testing evaluation, and security guidelines to improve code quality.

Related Skills

Explore More Software Engineering Skills→
rohanbhatia27rohanbhatia27
1

guidelines-advisor

Analyze Solidity smart contracts for best practices and common pitfalls.

Community
Advanced
diegocanepadiegocanepa

swe-architect

Analyze software requirements and generate architecture documentation with Mermaid diagrams.

Community
Intermediate
jtucker9jtucker9

dependency-audit

Audit project dependencies for vulnerabilities and supply-chain risks.

Community
Advanced
Pact-Community-OrganizationPact-Community-Organization
1

security-audit

Audit Pact 5 smart contracts across five phases and generate a formal security report.

Official
Advanced