Introduction
Relevant source files
The following files were used as context for generating this wiki page:
The OpenCode Skills Collection is a modular repository of specialized "agent skills" designed to enhance the capabilities of AI documentation engineers and software architects. This collection provides standardized workflows, templates, and procedures for generating high-quality technical artifacts, ranging from comprehensive project READMEs to complex C4 architecture diagrams and specialized onboarding guides. Sources: bundled-skills/documentation/SKILL.md, bundled-skills/wiki-architect/SKILL.md
The core purpose of this system is to transform raw codebase analysis into structured, evidence-based documentation. By utilizing a hierarchical "catalogue" approach, the system ensures that every technical claim is grounded in actual source code through mandatory file-path and line-number citations. This "Introduction" module serves as the entry point for understanding the system's architecture, the various documentation tiers, and the specific skills required to maintain codebase transparency. Sources: bundled-skills/wiki-page-writer/SKILL.md:12-20, bundled-skills/wiki-architect/SKILL.md:16-25
Documentation Architecture
The system follows a structured hierarchy designed to cater to different levels of engineering expertise, from new contributors to principal-level architects. The architecture is divided into clear layers: Presentation, Business Logic, and Data Access. Sources: bundled-skills/wiki-architect/SKILL.md:10-14
Hierarchical Catalogue Structure
The documentation is organized into a four-level hierarchical JSON catalogue that defines the navigation and depth of the generated wiki.
| Level | Name | Focus |
|---|---|---|
| 1 | Onboarding | Principal-Level and Zero-to-Hero guides. |
| 2 | Getting Started | Overview, setup, usage, and quick reference. |
| 3 | Deep Dive | Subsystems, components, and method-level details. |
| 4 | References | Glossary, API specs, and technical debt logs. |
Sources: bundled-skills/wiki-architect/SKILL.md:18-24, bundled-skills/wiki-onboarding/SKILL.md:18-35
The Documentation Workflow
The documentation process follows a strict phase-based lifecycle, moving from planning to maintenance.
This diagram illustrates the progression of documentation tasks from initial structure definition to long-term upkeep. Sources: bundled-skills/documentation/SKILL.md:20-100
Core Documentation Skills
The repository is built around specialized "Skills," which are encapsulated instructions for the documentation engine. Each skill has specific triggers and depth requirements. Sources: bundled-skills/wiki-page-writer/SKILL.md:1-8
Wiki Page Writer
The wiki-page-writer is a senior documentation engineer persona that generates deep-dive content. It has non-negotiable requirements for tracing actual code paths and distinguishing fact from inference. Sources: bundled-skills/wiki-page-writer/SKILL.md:11-15
Depth Requirements:
- Trace Actual Code Paths: No guessing from file names.
- Evidence-Based: Every claim requires a file path and function/class citation.
- First Principles: Explain why a component exists before what it does.
Sources: bundled-skills/wiki-page-writer/SKILL.md:12-16
Onboarding Guide Generator
This skill targets two distinct audiences:
- Principal-Level: Focuses on system philosophy, design principles, and strategic technical debt. Sources: bundled-skills/wiki-onboarding/SKILL.md:20-35
- Zero-to-Hero: Focuses on environment setup, local development workflow, and "Your First Task" walkthroughs. Sources: bundled-skills/wiki-onboarding/SKILL.md:38-55
Implementation Standards
To ensure consistency across the wiki, all generated pages must adhere to specific formatting and technical standards. Sources: bundled-skills/documentation-templates/SKILL.md:10-15
Mandatory Page Elements
Every wiki page generated by the system must include:
- VitePress Frontmatter: Title and description for SEO and site indexing.
- Mermaid Diagrams: At least two diagrams per page using specific dark-mode hex codes (e.g., node fill
#2d333b). - Citations: A minimum of 5 different source files cited per page.
- Tables: For summarizing APIs, configurations, and component responsibilities.
Sources: bundled-skills/wiki-page-writer/SKILL.md:32-60
Logic Flow: From Code to Wiki
The system uses automated analysis to determine how to document a feature.
The sequence above shows the internal logic used to bridge raw code and the final documentation site. Sources: bundled-skills/wiki-architect/SKILL.md:8-15, bundled-skills/wiki-page-writer/SKILL.md:21-27
Conclusion
The OpenCode Skills Collection provides a robust framework for maintaining technically accurate and highly navigable documentation. By enforcing strict evidence standards and catering to diverse engineering personas, it ensures that the "Introduction" to any project is not just a high-level summary, but a gateway to a deeply understood and easily maintainable codebase. Sources: bundled-skills/wiki-page-writer/SKILL.md:58-62, bundled-skills/wiki-onboarding/SKILL.md:10-15