openspec-onboard

Guides users through the complete OpenSpec workflow cycle on their own codebase.

1|Updated Jul 30, 2023

Search Tags:#git #workflow #developer tools #onboarding #openspec #codebase management

Ready to run

npx skills add https://github.com/DanielShuguang/tool-box --skill openspec-onboard-danielshuguang

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: openspec-onboard
Source: https://github.com/DanielShuguang/tool-box/tree/main/.trae/skills/openspec-onboard
Command: npx skills add https://github.com/DanielShuguang/tool-box --skill openspec-onboard-danielshuguang

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires openspec-cn, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill guides new users through their first complete OpenSpec workflow cycle, from identifying a task to archiving a completed change, directly within their own codebase.

Core Features & Use Cases

Guided Workflow: Step-by-step instruction on using OpenSpec commands and concepts.
Real-world Task Integration: Identifies and helps select a small, actionable task from the user's actual codebase.
Artifact Generation: Assists in creating essential OpenSpec artifacts: proposal, specs, design, and tasks.
Use Case: A new developer joins a team using OpenSpec. This Skill onboard them by walking them through fixing a small bug, explaining each OpenSpec command and artifact along the way.

Quick Start

Run the openspec-onboard skill to be guided through your first OpenSpec workflow.

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 a git codebase management workflow?▼

Onboard new developers by guiding them through a complete change cycle in their own codebase, from task selection to archiving. This workflow teaches essential commands and artifact creation, ensuring developers understand codebase management processes.

What is the OpenSpec workflow for creating proposals and specs?▼

The OpenSpec workflow is a codebase management process that guides users through creating proposals, specs, designs, and tasks. It integrates directly with your project to facilitate artifact generation and track changes from proposal to archiving.

How do I start my first OpenSpec workflow cycle using my own codebase?▼

Start your first OpenSpec workflow by running the onboarding skill, which identifies a small actionable task from your codebase. It then provides step-by-step instruction to generate artifacts, implement the change, and archive it.

Do I need the OpenSpec CLI to manage specs and design artifacts?▼

Yes, you need the OpenSpec CLI to execute commands and interact with your project during the workflow. The CLI facilitates task selection, artifact creation, and the archiving of completed changes within your codebase.

Can I use the OpenSpec workflow to fix a small bug in my project?▼

Yes, you can use the OpenSpec workflow to fix a small bug by selecting it as an actionable task. The workflow walks you through creating the necessary proposals and specs, implementing the fix, and archiving the change.

What are the limitations of using an onboarding skill for codebase management?▼

This onboarding skill focuses on guiding users through a single complete change cycle using a small task. It requires the OpenSpec CLI and existing project dependencies to function, limiting its use to existing codebase environments.