docs-analysis

Analyze project documentation to extract invariants and map trust assumptions.

60|18|Updated Jan 21, 2026
One-click install
npx skills add https://github.com/PurpleAILAB/Vigilo --skill docs-analysis-purpleailab
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-analysis
Source: https://github.com/PurpleAILAB/Vigilo/tree/main/packages/claude/skills/docs-analysis
Command: npx skills add https://github.com/PurpleAILAB/Vigilo --skill docs-analysis-purpleailab

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the initial reconnaissance phase of smart contract auditing by analyzing project documentation to quickly understand protocol mechanics, identify critical invariants, and map trust assumptions.

Core Features & Use Cases

  • Documentation Discovery: Automatically finds and prioritizes relevant documentation files (READMEs, SECURITY.md, whitepapers, etc.).
  • Invariant Extraction: Identifies explicit and infers implicit invariants that the protocol must uphold.
  • Trust Assumption Mapping: Details who is trusted, for what actions, and what safeguards are in place.
  • Use Case: When auditing a new DeFi protocol, use this Skill to rapidly generate a summary of its core logic, security assumptions, and potential weak points directly from its documentation, significantly speeding up the auditor's understanding.

Quick Start

Analyze the documentation for the current project to identify core invariants and trust assumptions.

Frequently Asked Questions about docs-analysis

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

FAQPage Schema
How do I extract invariants from smart contract documentation during an audit?

To extract invariants from smart contract documentation, the skill analyzes project files like READMEs and whitepapers to identify explicit rules and infer implicit invariants that the protocol must uphold. It automates this reconnaissance phase by locating relevant docs using glob patterns and extracting key security information.

What is trust assumption mapping in a DeFi protocol security audit?

Trust assumption mapping in a DeFi protocol security audit details who is trusted, for what specific actions, and what safeguards are in place. The skill automates this by analyzing documentation to map out these trust boundaries and protocol mechanics for auditors.

How do I find relevant security documentation in a smart contract project?

To find relevant security documentation in a smart contract project, the skill uses glob patterns to automatically discover and prioritize files like READMEs, SECURITY.md, and whitepapers. This documentation discovery process accelerates the initial audit reconnaissance phase.

Can I classify protocol type from whitepapers and READMEs automatically?

Yes, you can classify protocol type from whitepapers and READMEs automatically. The skill applies predefined questions and protocol type heuristics to the discovered documentation to quickly categorize the protocol and understand its core logic during security audits.

Does this documentation analysis approach work for any smart contract protocol?

This documentation analysis approach works for smart contract protocols that maintain written documentation such as whitepapers or SECURITY.md files. It relies on discovering these text files to map trust assumptions and extract invariants, so undocumented protocols will not yield useful audit reconnaissance results.

What is the best way to speed up the reconnaissance phase of a smart contract audit?

The best way to speed up the reconnaissance phase of a smart contract audit is to automate documentation analysis. The skill rapidly generates a summary of core logic, security assumptions, and potential weak points directly from project docs, significantly accelerating auditor understanding.