openspec-onboard

Guides teams through an end-to-end OpenSpec onboarding workflow in a real codebase.

Updated May 29, 2025

Search Tags:#workflow #onboarding #codebase #tutorial #openspec #developer-training

Ready to run

npx skills add https://github.com/crozzbite/DnDApp --skill openspec-onboard-crozzbite

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: openspec-onboard
Source: https://github.com/crozzbite/DnDApp/tree/main/.github/skills/openspec-onboard
Command: npx skills add https://github.com/crozzbite/DnDApp --skill openspec-onboard-crozzbite

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Open onboarding for OpenSpec is simplified by guiding users through a complete workflow cycle with narration and practical, in-repo tasks.

Core Features & Use Cases

Guided, phase-based onboarding spanning preflight, task selection, explore, change creation, proposal, specs, design, tasks, apply, and archive.
Real codebase interactions with hands-on tasks to illustrate the workflow end-to-end.
Reusable templates and artifacts (proposal, specs, design, tasks) that teams can adapt to their projects.

Quick Start

Start the onboarding by running the OpenSpec onboarding skill in your repository.

Frequently Asked Questions about openspec-onboard

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

FAQPage Schema

How do I onboard new developers to an OpenSpec workflow in a real codebase?▼

OpenSpec onboarding guides new developers through a complete workflow cycle in a real codebase, using hands-on tasks and interactive narration across multiple phases from preflight to archive.

What is the OpenSpec lifecycle and how does phase-based developer training work?▼

The OpenSpec lifecycle spans preflight, task selection, explore, change creation, proposal, specs, design, tasks, apply, and archive. Developer training works by guiding teams through each phase with interactive, in-repo tasks.

Do I need a SKILL.md file to start developer onboarding in my repository?▼

Yes, you need a YAML frontmatter file named SKILL.md at the repository root with name and description. Optional assets, scripts, and references directories can also be included to support the onboarding workflow.

How to use the explain/do/show/pause interaction pattern for codebase onboarding?▼

The explain/do/show/pause pattern is an explicit interaction model used during codebase onboarding. It structures the guided workflow by alternating between explaining concepts, executing tasks, showing results, and pausing for learner input.

What templates and artifacts are generated during the OpenSpec workflow cycle?▼

The OpenSpec workflow cycle generates reusable templates and artifacts including proposals, specs, designs, and tasks. Teams can adapt these outputs to fit their specific project requirements throughout the onboarding process.

Can I use OpenSpec onboarding for interactive developer training without external dependencies?▼

Yes, OpenSpec onboarding operates entirely within your repository using an explicit interaction pattern and local directories. It requires no external dependencies, only a SKILL.md file and optional asset directories to run.