What counts as an 'effect' in this skill?

Following the foundational principle that 'everything is an effect,' this includes database operations, external API calls, file system access, framework-specific handlers, and even pure computations or logging.

How does this skill help with C4 diagrams?

By classifying effects into groups like 'io:database' or 'io:network', the tool can automatically generate accurate C4 container and component diagrams that reflect the actual behavior of the code.

Does this skill work with existing projects?

Yes. The 'devac effects init' command performs an initial AST analysis to discover patterns in your existing codebase and generates a draft documentation file to get you started.

What happens if my code changes and the documentation is old?

You can run the 'devac effects verify' command. It compares your documented effects against the actual code, highlighting unmapped patterns or stale documentation that needs updating.

Define Effects Mapper

Name: Define Effects Mapper
Author: pietgk

bypietgk

•

Aprendizaje y Documentación

Standardizes effect classification and documentation to maintain a single source of truth for package architecture.

The Define Effects skill automates the discovery, classification, and maintenance of 'effects' within your codebase, treating every operation—from database writes to API calls—as a traceable event. By generating a centralized package-effects.md file, it bridges the gap between raw code and architectural diagrams (like C4), ensuring that your documentation stays in sync with actual implementation through automated verification and TypeScript rule extraction. This is essential for developers who need to audit side effects, map dependencies, or generate accurate system documentation directly from their source code.

Características Principales

01Architectural Verification: Detects 'drift' by reporting unmapped or stale patterns between code and documentation.

02C4 Diagram Integration: Powers accurate container and component diagrams based on verified effect metadata.

03TypeScript Syncing: Generates extraction rules directly from Markdown documentation for consistent code analysis.

04Standardized Classification: Categorizes code into specific group types such as io:*, compute:*, and framework:* for filtered viewing.

05Automated Effect Discovery: Scans AST to identify patterns like store operations, external calls, and request handlers.

061 GitHub stars

Casos de Uso

01Maintaining up-to-date documentation of API endpoints and database dependencies for large teams.

02Enforcing documentation compliance in CI/CD by verifying new code patterns against recorded effect mappings.

03Mapping legacy codebase side-effects during architectural reviews or refactoring.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add pietgk/vivief define-effects

For use in Claude.ai and ChatGPT

Download Skill