What output format does this skill provide?

It generates or updates a structured Markdown file located at docs/package-explained.md within the targeted package directory.

Do I need to run any commands before using this skill?

Yes, for the most accurate results, you should run 'devac analyze' on the package first to ensure the code graph is fully populated with symbol and effect data.

How does the skill gather package information?

The skill utilizes the DevAC analysis tool to query the code graph for file symbols, import patterns, and execution effects like database operations or external API calls.

Can I customize the generated documentation?

The skill provides a standardized architectural baseline, which developers are encouraged to review, refine, and add specific business context to as needed.

Can it identify interactions with third-party services?

Yes, by analyzing 'Send' operations and import patterns, the skill identifies and lists external dependencies and third-party service integrations.

Package Documentation Architect

Name: Package Documentation Architect
Author: pietgk

bypietgk

•

Aprendizaje y Documentación

Generates comprehensive, human-readable documentation for code packages by analyzing internal symbols and external dependencies.

The Package Documentation Architect skill automates the creation of high-level package overviews using the DevAC code analysis engine. It goes beyond simple comments to map out structural relationships, data flow effects, and service dependencies, making it invaluable for onboarding new developers or auditing complex legacy modules. By producing a standardized package-explained.md file, it ensures that architectural intent remains visible and documented throughout the development lifecycle, allowing teams to maintain a deep understanding of their codebase as it scales.

Características Principales

01Deep code context and symbol hierarchy analysis

02Internal and external dependency visualization

03Structured data store and API endpoint reporting

04Automated package overview generation in Markdown

05Mapping of database and external API side effects

061 GitHub stars

Casos de Uso

01Onboarding developers to a new or complex codebase by providing instant architecture summaries

02Auditing legacy packages to understand their responsibilities and side effects before refactoring

03Maintaining up-to-date documentation in fast-moving monorepos or microservice architectures

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add pietgk/vivief explain-package

For use in Claude.ai and ChatGPT

Download Skill