Can this skill incorporate non-code knowledge?

Yes, it specifically reads from a tacit-insights source to include critical context and tribal knowledge that cannot be extracted from the code alone.

What are M1-M4 quality rules?

These are meta-rules applied to ensure set completeness (M1) and generic-to-specific conceptual explanations (M2) in architectural output.

How does the skill ensure documentation accuracy?

It utilizes DevAC tools to query raw effects and schemas, then verifies all claims against source code using specific file and line references.

What is the effectHandler pattern used by this skill?

The pattern is defined as (State, Effect) => (State', [Effects']), a functional approach for predictable state transitions and side-effect management within a system.

Effects Architecture Documentation

Name: Effects Architecture Documentation
Author: pietgk

bypietgk

•

学習とドキュメンテーション

Generates and verifies architecture documentation using the effectHandler pattern for robust system state management.

The Effects Architecture skill empowers developers to document and validate complex state-effect management systems using the functional effectHandler pattern. By leveraging the DevAC toolset and M1-M4 quality rules, it creates high-fidelity architecture documentation with built-in confidence markers and direct source verification. This skill is ideal for teams needing to bridge the gap between complex code implementations and conceptual design documentation, ensuring that every architectural claim is backed by verified file-and-line references.

主な機能

01Integration of tacit insights for knowledge not detectable in raw code

02Source-code verification using DevAC tools for file-level accuracy

03Automated generation of verified architecture documentation with confidence markers

041 GitHub stars

05Support for ADR-aligned formalization of effect handlers

06Application of M1-M4 quality rules for documentation completeness

ユースケース

01Verifying that existing documentation remains in sync with the current codebase

02Explaining complex effect-handler logic and state transitions to team members

03Generating formal architecture documentation for state-management systems

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add pietgk/vivief effects-architecture

For use in Claude.ai and ChatGPT

Download Skill