skills.rest
CagesThrottleUs
CagesThrottleUsCOMMUNITY
Explore all skills by this author →
GitHub

onboarding-guide

Generates wiki/ONBOARDING.md by synthesizing HLD diagrams, ADRs, OpenAPI specs, and observability docs.

Updated May 21, 2026
Search Tags:#documentation#onboarding#openapi#adr#developer experience#wiki#c4 diagrams
One-click install
npx skills add https://github.com/CagesThrottleUs/private-ai-harness --skill onboarding-guide-cagesthrottleus
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: onboarding-guide
Source: https://github.com/CagesThrottleUs/private-ai-harness/tree/main/skills/onboarding-guide
Command: npx skills add https://github.com/CagesThrottleUs/private-ai-harness --skill onboarding-guide-cagesthrottleus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? New developers joining a project lack a single, current onboarding document, forcing them to piece together architecture, setup, and operational knowledge from scattered artifacts. This Skill assembles existing harness artifacts into one structured guide so a developer with no prior context becomes productive in under one day. ## Core Features & Use Cases - Artifact Synthesis: Reads HLD C4 diagrams, ADRs, OpenAPI specs, SLO documents, and business context to produce eight required sections without inventing content. - Dev Setup Generation: Detects package manifests (package.json, pyproject.toml, go.mod, Cargo.toml) and CI config to produce verified setup commands. - Reviewer Gate: Dispatches an onboarding-reviewer agent and fixes Critical findings before committing wiki/ONBOARDING.md. - Use Case: At a project's first production release, run the Skill to generate a complete onboarding guide covering system overview, architecture tour, key ADRs, API reference, first contribution tutorial, and ops/monitoring. ## Quick Start Ask the AI to generate the onboarding guide from the existing HLD, ADRs, OpenAPI spec, and observability docs into wiki/ONBOARDING.md.

Frequently Asked Questions about onboarding-guide

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

FAQPage Schema
How do I create a developer onboarding guide for my project?▼

Run this Skill after your first production release. It reads your HLD C4 diagrams, ADRs, OpenAPI spec, and observability docs, then generates wiki/ONBOARDING.md with eight required sections including setup, architecture tour, and a first-contribution tutorial.

What sections should a software onboarding document include?▼

This guide produces eight sections: system overview, dev environment setup, architecture tour, key ADRs, API reference, first contribution guide, ops/monitoring, and a where-to-find-things index. The structure follows the Microsoft Engineering Fundamentals Playbook template.

When should I regenerate the onboarding guide?▼

Regenerate at the first production release, after major architectural changes to the HLD, or when the guide is more than six months old. Skip it for routine feature PRs since the guide is maintained, not regenerated per feature.

Does the onboarding guide work without existing architecture docs?▼

No. The Skill synthesizes existing artifacts and does not invent content. It checks prerequisites first and flags missing HLD, ADRs, observability docs, or OpenAPI specs before generating anything.

How is the generated onboarding guide reviewed before commit?▼

The Skill dispatches an onboarding-reviewer agent with the guide path, HLD path, and spec path. All Critical findings must be fixed and the reviewer re-run until it passes before committing wiki/ONBOARDING.md.

Related Skills

Explore More Software Engineering Skills→
e-t-y-be-t-y-b
9

system-architect

Design end-to-end system architecture with ADRs, C4 diagrams, and OpenAPI specs.

Official
Advanced
withmartian-sandboxwithmartian-sandbox

publish-wiki

Publish pending wiki changes from a local directory to the GitHub Wiki repository.

Official
Intermediate
innFactory-AIinnFactory-AI

tech-docs-skill

Generates API references, runbooks, ADRs, onboarding guides, and READMEs from code context.

Official
Intermediate
asengardeonasengardeon

sdd-baseline

Generates baseline documentation for undocumented legacy codebases via a codebase-archaeologist agent.

Community
Basic