AgentSkillsCN

onboard-me

为新加入项目的工程师生成一份易于理解的入职指南。它与/ init(为Claude Code创建CLAUDE.md)相辅相成,侧重于阐明应用程序的用途、存在的意义,以及如何思考这款应用——而非如何运行它。适用于以下场景:(1) 迎接新工程师;(2) 记录业务逻辑与主要流程;(3) 为开发者提供一份数周后仍可查阅的参考文档。

SKILL.md
--- frontmatter
name: onboard-me
description: "Produces a human-readable onboarding document for new engineers joining the project. Complements /init (which creates CLAUDE.md for Claude Code) by focusing on what the application does, why it exists, and how to think about it — not how to run it. Use when: (1) onboarding a new engineer, (2) documenting business logic and main flows, (3) creating a reference a developer can return to weeks later."

Onboard me

You are a senior software engineer acting as a technical onboarding guide for this repository.

Your goal is to produce a high-quality, detailed Markdown document that allows a new engineer to onboard quickly and start delivering value fast.


Before you start

Check if a CLAUDE.md exists at the project root. If it does:

  • Do not repeat commands, build steps, or technical setup — those are already covered.
  • Do not repeat the architecture overview if it is already well-documented there.
  • Instead, reference CLAUDE.md at the top of the output: "For commands and technical setup, see CLAUDE.md."

Objectives

Focus on what CLAUDE.md and /init do not cover:

  1. What this application does and why it exists — its purpose, who uses it, what problem it solves
  2. Main flows end-to-end — adapt to the tech stack found in the repo:
    • Entry points: HTTP endpoints, event consumers, scheduled jobs, CLI commands, UI pages — whatever applies
    • For each flow: describe what triggers it, what it does, and what the outcome is
    • Note key files/classes/components involved in each flow
  3. Domain concepts and data model — what are the core entities, what do they represent, how are they related
  4. External dependencies — third-party services, APIs, or systems this app integrates with and why
  5. Mental models and diagrams (in text/ASCII form) — help the reader build intuition, not just knowledge
  6. Where to start — if a new engineer needs to make their first change, where should they look first and why
  7. What to be careful about — known gotchas, non-obvious constraints, things that are easy to break

Output format

  • Markdown, clear section headings, bullet points and tables where useful
  • Be concrete — avoid vague descriptions, name actual files and components
  • Assume the reader has strong engineering skills but zero context about this repo
  • Add a notice at the top that this document is AI-generated and should be reviewed carefully
  • Save as: docs/onboarding-architecture.md