AGENT SKILL

wiki-onboarding

Generate two complementary onboarding documents that together give any engineer — from newcomer to principal — a complete understanding of a codebase. Use when user asks for onboarding docs or getting-started guides, user runs /deep-wiki, or user wants to help new team members understand a codebase.

License 许可
MIT
最近更新
2026-05-10
Stars
★ 1
Forks
1

01 前言 Front Matter

name
wiki-onboarding
risk
unknown
source
community
date_added
2026-02-27
description
Generate two complementary onboarding documents that together give any engineer — from newcomer to principal — a complete understanding of a codebase. Use when user asks for onboarding docs or getting-started guides, user runs /deep-wiki, or user wants to help new team members understand a codebase.

03 SKILL.md 正文

Wiki Onboarding Guide Generator

Generate two complementary onboarding documents that together give any engineer — from newcomer to principal — a complete understanding of a codebase.

When to Use

  • User asks for onboarding docs or getting-started guides
  • User runs /deep-wiki:onboard command
  • User wants to help new team members understand a codebase

Language Detection

Scan the repository for build files to determine the primary language for code examples:

  • package.json / tsconfig.json → TypeScript/JavaScript
  • *.csproj / *.sln → C# / .NET
  • Cargo.toml → Rust
  • pyproject.toml / setup.py / requirements.txt → Python
  • go.mod → Go
  • pom.xml / build.gradle → Java

Guide 1: Principal-Level Onboarding

Audience: Senior/staff+ engineers who need the "why" behind decisions.

Required Sections

  1. System Philosophy & Design Principles — What invariants does the system maintain? What were the key design choices and why?
  2. Architecture Overview — Component map with Mermaid diagram. What owns what, communication patterns.
  3. Key Abstractions & Interfaces — The load-bearing abstractions everything depends on
  4. Decision Log — Major architectural decisions with context, alternatives considered, trade-offs
  5. Dependency Rationale — Why each major dependency was chosen, what it replaced
  6. Data Flow & State — How data moves through the system (traced from actual code, not guessed)
  7. Failure Modes & Error Handling — What breaks, how errors propagate, recovery patterns
  8. Performance Characteristics — Bottlenecks, scaling limits, hot paths
  9. Security Model — Auth, authorization, trust boundaries, data sensitivity
  10. Testing Strategy — What's tested, what isn't, testing philosophy
  11. Operational Concerns — Deployment, monitoring, feature flags, configuration
  12. Known Technical Debt — Honest assessment of shortcuts and their risks

Rules

  • Every claim backed by (file_path:line_number) citation
  • Minimum 3 Mermaid diagrams (architecture, data flow, dependency graph)
  • All Mermaid diagrams use dark-mode colors (see wiki-vitepress skill)
  • Focus on WHY decisions were made, not just WHAT exists

Guide 2: Zero-to-Hero Contributor Guide

Audience: New contributors who need step-by-step practical guidance.

Required Sections

  1. What This Project Does — 2-3 sentence elevator pitch
  2. Prerequisites — Tools, versions, accounts needed
  3. Environment Setup — Step-by-step with exact commands, expected output at each step
  4. Project Structure — Annotated directory tree (what lives where and why)
  5. Your First Task — End-to-end walkthrough of adding a simple feature
  6. Development Workflow — Branch strategy, commit conventions, PR process
  7. Running Tests — How to run tests, what to test, how to add a test
  8. Debugging Guide — Common issues and how to diagnose them
  9. Key Concepts — Domain-specific terminology explained with code examples
  10. Code Patterns — "If you want to add X, follow this pattern" templates
  11. Common Pitfalls — Mistakes every new contributor makes and how to avoid them
  12. Where to Get Help — Communication channels, documentation, key contacts
  13. Glossary — Terms used in the codebase that aren't obvious
  14. Quick Reference Card — Cheat sheet of most-used commands and patterns

Rules

  • All code examples in the detected primary language
  • Every command must be copy-pasteable
  • Include expected output for verification steps
  • Use Mermaid for workflow diagrams (dark-mode colors)
  • Ground all claims in actual code — cite (file_path:line_number)

When to Use

This skill is applicable to execute the workflow or actions described in the overview.

Limitations

  • Use this skill only when the task clearly matches the scope described above.
  • Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
  • Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

04 同仓库更多 Skills

Sansar35
Sansar35/claude-agent

zustand-store-ts

Create Zustand stores following established patterns with proper TypeScript types and middleware.

★ 1
Sansar35
Sansar35/claude-agent

zod-validation-expert

Expert in Zod — TypeScript-first schema validation. Covers parsing, custom errors, refinements, type inference, and integration with React Hook Form, Next.js, and tRPC.

★ 1
Sansar35
Sansar35/claude-agent

zinc-database

Access ZINC (230M+ purchasable compounds). Search by ZINC ID/SMILES, similarity searches, 3D-ready structures for docking, analog discovery, for virtual screening and drug discovery.

★ 1
Sansar35
Sansar35/claude-agent

zarr-python

Chunked N-D arrays for cloud storage. Compressed arrays, parallel I/O, S3/GCS integration, NumPy/Dask/Xarray compatible, for large-scale scientific computing pipelines.

★ 1
Sansar35
Sansar35/claude-agent

zapier-workflows

Manage and trigger pre-built Zapier workflows and MCP tool orchestration. Use when user mentions workflows, Zaps, automations, daily digest, research, search, lead tracking, expenses, or asks to "run" any process. Also handles Perplexity-based research and Google Sheets data tracking.

★ 1
Sansar35
Sansar35/claude-agent

zapier-make-patterns

No-code automation democratizes workflow building. Zapier and Make (formerly Integromat) let non-developers automate business processes without writing code. But no-code doesn't mean no-complexity - these platforms have their own patterns, pitfalls, and breaking points. This skill covers when to use which platform, how to build reliable automations, and when to graduate to code-based solutions. Key insight: Zapier optimizes for simplicity and integrations (7000+ apps), Make optimizes for power

★ 1