Explain Package Skill

Generate package documentation from DevAC code graph analysis.

3|Updated Dec 15, 2025
One-click install
npx skills add https://github.com/pietgk/vivief --skill explain-package-skill
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Explain Package Skill
Source: https://github.com/pietgk/vivief/tree/main/plugins/devac/skills/explain-package
Command: npx skills add https://github.com/pietgk/vivief --skill explain-package-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation of human-readable package documentation by analyzing code structure, symbols, and dependencies to produce a coherent overview.

Core Features & Use Cases

  • Package Overview Generation: Produces docs/package-explained.md detailing purpose, responsibilities, and key components.
  • Code Context Analysis: Leverages the code graph to reveal symbol relationships, imports/exports, and effect patterns.
  • Dependency & Integration Mapping: Identifies internal and external dependencies and how the package integrates with other systems.
  • Automation Workflow: Out-of-the-box steps from symbol extraction to documentation generation.

Quick Start

Explain a package to generate its documentation by analyzing its code graph and dependencies.

Frequently Asked Questions about Explain Package Skill

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

FAQPage Schema
How do I auto-generate package documentation from code structure?

Auto-generating package documentation is done by analyzing code structure, symbols, and dependencies to output a human-readable docs/package-explained.md file. It details the package purpose, components, and integration points.

Why does generating package docs from code structure require dependency mapping?

Generating package docs requires dependency mapping to identify internal and external dependencies and reveal how the package integrates with other systems. This dependency analysis forms the core context for the documentation output.

Can I use code graph analysis to document package responsibilities and imports?

Yes, code graph analysis reveals symbol relationships, imports, exports, and effect patterns to document package responsibilities. The code graph provides the structural context needed to generate the docs/package-explained.md file.

Do I need DevAC analysis to generate the package-explained.md file?

Yes, DevAC analysis is required to extract symbols, effects, and dependencies queries before generating the package-explained.md file. The documentation generation workflow depends directly on this prior code graph analysis.

What is the best way to automate documentation for a code package?

The best way to automate documentation for a code package is using an out-of-the-box workflow that runs from symbol extraction to documentation generation. This process produces a comprehensive docs/package-explained.md file detailing purpose and components.