skills.rest
michaelvolz
michaelvolzCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

onboarding

Generate ONBOARDING.md with six sections from repository inventory and README data.

Updated Nov 11, 2023
Search Tags:#documentation#onboarding#inventory#repo-analysis#knowledge-transfer#new-contributor
One-click install
npx skills add https://github.com/michaelvolz/redmuffin.Blazor.StaticWeb --skill onboarding-michaelvolz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: onboarding
Source: https://github.com/michaelvolz/redmuffin.Blazor.StaticWeb/tree/main/.opencode/skills/ce/onboarding
Command: npx skills add https://github.com/michaelvolz/redmuffin.Blazor.StaticWeb --skill onboarding-michaelvolz

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Lack of onboarding guidance leaves every new contributor guessing the repo layout and conventions, so this skill builds a fresh ONBOARDING.md by reading the README, entry points, and key files the inventory script surfaces. Running it once gives you a curated guide that points to the right commands, architecture maps, and dependencies without handholding.

Core Features & Use Cases

  • Repository inventory: scripts/inventory.mjs walks the tree, catalogs entry points, detects frameworks, and flags docs so the narrative always starts from actual structure.
  • Structured six-section output: The generated ONBOARDING.md follows the required flow, adding ASCII diagrams, responsibility tables, dependency tables, and concrete how-to tips for each section.
  • Use Case: Use this skill whenever a repo lacks onboarding docs or you want to refresh guidance for a new hire, replacing stale prose with an accurate, code-derived overview.

Quick Start

Ask this skill to crawl the repo, run the inventory script, and overwrite ONBOARDING.md with the six-section guide for new contributors.

Frequently Asked Questions about onboarding

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

FAQPage Schema
How do I generate onboarding documentation for a new contributor to a repository?▼

To generate onboarding documentation, this skill reads the repository README, entry points, and key files to build a structured ONBOARDING.md. It uses an inventory script to crawl the codebase and output a six-section guide with ASCII diagrams and dependency tables.

What is the best way to create an ONBOARDING.md file from existing code?▼

The best way to create an ONBOARDING.md from existing code is to use an automated inventory script that walks the file tree, detects frameworks, and catalogs entry points. This ensures the documentation accurately reflects the actual repository structure and workflows.

Does this onboarding doc generator work for codebases lacking existing documentation artifacts?▼

Yes, this onboarding doc generator is specifically designed for codebases lacking onboarding artifacts. It derives the narrative directly from the source code structure and README data, ensuring new hires have a code-derived overview without needing manual handholding.

What sections and visual elements should a code-derived onboarding guide include?▼

A code-derived onboarding guide should include six prescribed sections featuring ASCII diagrams, responsibility tables, dependency tables, and concrete how-to tips. This structure maps out the architecture and key workflows for new contributors.

How do I inventory a repository to find entry points and frameworks before writing docs?▼

You can inventory a repository by running a script that walks the directory tree, catalogs entry points, detects frameworks, and flags existing docs. This process surfaces the key files needed to guide the narrative for onboarding documentation.

Will generating onboarding docs from repo code expose secrets or sensitive configuration data?▼

Generating onboarding docs from repo code will not expose secrets. The process builds the ONBOARDING.md by analyzing the structure, dependencies, and workflows while explicitly ensuring that no sensitive secrets are included in the resulting documentation.

Related Skills

Explore More Software Engineering Skills→
Canhada-LabsCanhada-Labs
2

core-codebase-onboarding

Generate a mental map of a new codebase with structure and dependencies.

Official
Advanced
unfinishablemapunfinishablemap
3

expand-topic

Generate a publish-ready article draft from a topic prompt.

Community
Intermediate
xingranyaxingranya
3

auto-wiki-generator

Generate and incrementally update Markdown wiki documentation from source code.

Community
Advanced
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic