Every project has two kinds of knowledge: the kind written in documentation, and the kind locked in people’s heads. When a new member or an agent takes over, they often spend a lot of time learning the “unwritten rules,” rather than reading the README. onboarding-pack aims to make this second kind of knowledge explicit, enabling agents or humans to acquire the project’s core context in 10 minutes.

What Is This

This is a memory-oriented plugin maintained by ChenneyZhuang. It documents implicit project knowledge, helping new members quickly understand how the project works, its authoritative sources, and its internal rules.

Core Features

The plugin uses a fixed five-section structure, with a total reading time of about 10 minutes:

  1. What & why: A brief explanation of what the project is, who it serves, and what the standard for “done” is.
  2. Run it: Provides the exact commands to generate a working setup.
  3. Map: Clarifies where resources are stored and which sources are authoritative (projects often have multiple conflicting information sources, and it must be clear which one wins).
  4. Unwritten rules: Lists the internal default rules (usually around five). These rules are obvious to insiders but invisible to newcomers (for example, “never edit file X directly”).
  5. Who & where: Lists owners, decision forums, and channels for asking questions.

Installation and Enablement

Add the plugin using the official install command:

npx skills add ChenneyZhuang/onboarding-pack

The current version is v0.1.0, and the license is MIT.

Typical Usage

  • Quickly obtain an environment: Run the commands provided by the plugin directly to get a working project setup.
  • Build an audit loop: Follow the “newcomer asks questions → add new entries” cycle. Unwritten rules will inevitably have gaps when first written, and must be continuously supplemented and corrected through ongoing work.

Applicable Scenarios and Caveats

  • Applicable scenarios: Suitable for project handoff, onboarding new members, or connecting agents to complex legacy systems.
  • Maintenance rule: The package must be updated as the project changes. If the package lags behind major project version changes, it should be treated with suspicion.
  • Permission caveat: The plugin runs with the current DSH process permissions. It is recommended to review the source code and license before installation.

By recording this implicit knowledge, onboarding-pack compresses what would originally have taken weeks of trial and error into a one-time cost of reading documentation.