onboarding-writer

Included with Lifetime

$97 forever

Synthesize analyzed codebase information into a structured onboarding document. Creates onboarding_doc.md. Triggered by onboarding-start during document-writing phase.

Writing & Docs

What this skill does


# Onboarding Writer

Synthesize gathered information into a structured onboarding document.

## Prerequisites

Before using this skill, ensure you have:
- `source_inventory.md` - List of code files, docs, and plans
- `extraction_tables.md` - Function tables, dependencies, data flow
- `gaps_pitfalls.md` - Non-obvious requirements, ordering, common errors

## Document Structure

Create `onboarding_doc.md` with these 7 sections:

### 1. Goal

One paragraph: what this achieves and why.

```markdown
## Goal

This document helps developers implement [feature] by providing
the essential context, entry points, and common pitfalls to avoid.
```

### 2. What to Read First

Numbered list of files in dependency order (3-7 items):

```markdown
## What to Read First

1. `config.py` - Configuration and environment setup
2. `types.py` - Core data structures
3. `main.py` - Entry point and orchestration
```

### 3. Current State

Table of key functions with line numbers (from `extraction_tables.md`):

```markdown
## Current State

| Function | File:Lines | Purpose |
|----------|-----------|---------|
| `init()` | `main.py:10-25` | Initialize configuration |
| `process()` | `main.py:27-50` | Main processing loop |
| `cleanup()` | `main.py:52-60` | Resource cleanup |
```

### 4. What Changes / How to Implement

Ordered steps in dependency order:

```markdown
## How to Implement

1. **Add the new handler** in `handlers.py:100`
   - Why: All handlers must be registered before server starts

2. **Update config** in `config.py:50`
   - Add new setting to the config schema

3. **Wire up in main** in `main.py:30`
   - Import and call the new handler
```

### 5. Verification

Bullet list of testable success criteria:

```markdown
## Verification

- [ ] Running `python main.py --test` shows no errors
- [ ] New endpoint responds at `/api/v1/new`
- [ ] Logs show "Handler registered" message
```

### 6. Pitfalls

Numbered list from `gaps_pitfalls.md`:

```markdown
## Pitfalls

1. **Initialize config first** - API calls fail without config
2. **Check environment** - Requires `API_KEY` env var
3. **Order matters** - Register handlers before `start()`
```

### 7. Files

Table of files to create or modify:

```markdown
## Files

| File | Action | Reason |
|------|--------|--------|
| `handlers.py` | Modify | Add new handler |
| `config.py` | Modify | Add new setting |
| `tests/test_handler.py` | Create | Test coverage |
```

## Style Guidelines

- **Tables over prose**: Use tables for structured data
- **Line numbers**: Always include in format `file.py:42-50`
- **Minimal code**: Only signatures or one-liners (max 3 lines)
- **High-level**: Describe what to do, not exact code
- **Dependency order**: List steps in order they must be done

## Success Criteria

- [ ] All 7 sections present
- [ ] Follows style guidelines
- [ ] No code blocks longer than 3 lines
- [ ] Line numbers verified accurate
- [ ] Someone can implement using only this doc

Files: 1

Size: 3.1 KB

Complexity: 6/100

Category: Writing & Docs

Source: https://github.com/ohadrubin/skills/tree/main/skills/onboarding-doc/onboarding-writer

Related in Writing & Docs

jax-development

Included

Use this skill when the user is writing, debugging, profiling, refactoring, reviewing, benchmarking, parallelising, exporting, or explaining JAX code, or when they mention JAX, jax.numpy, jit, grad, value_and_grad, vmap, scan, lax, random keys, pytrees, jax.Array, sharding, Mesh, PartitionSpec, NamedSharding, pmap, shard_map, Pallas, XLA, StableHLO, checkify, profiler, or the JAX repo. It helps turn NumPy or PyTorch-style code into pure functional JAX, fix tracer/control-flow/shape/PRNG bugs, remove recompiles and host-device syncs, choose transforms and sharding strategies, inspect jaxpr/lowering/IR, and benchmark compiled code correctly.

Writing & Docsscripts

nature-article-writer

Included

Drafts, rewrites, diagnostically critiques, and style-calibrates primary research manuscripts for Nature and Nature Portfolio journals. Use when the user wants a Nature-style title, summary paragraph or abstract, introduction, results, discussion, methods, figure legends, presubmission enquiry, cover letter, reviewer response, or when a scientific draft sounds generic, jargon-heavy, structurally weak, or AI-ish and needs precise, broad-reader-friendly prose without inventing data, analyses, or references. Best for primary research articles and letters rather than reviews or press releases unless explicitly adapting one.

Writing & Docsscripts

deckrd

Included

Document-driven framework that derives requirements, specifications, implementation plans, and executable tasks from goals through structured AI dialogue. Use when user says "write requirements", "create spec", "plan implementation", "derive tasks", "structure this feature", "break down into tasks", or "document this module". Also use for reverse engineering existing code into docs (/deckrd rev). Do NOT use for direct code writing — use /deckrd-coder after tasks are generated. Do NOT use when the user only wants to run or fix existing code without planning.

Writing & Docsscripts

clinical-decision-support

Included

Generate professional clinical decision support (CDS) documents for pharmaceutical and clinical research settings, including patient cohort analyses (biomarker-stratified with outcomes) and treatment recommendation reports (evidence-based guidelines with decision algorithms). Supports GRADE evidence grading, statistical analysis (hazard ratios, survival curves, waterfall plots), biomarker integration, and regulatory compliance. Outputs publication-ready LaTeX/PDF format optimized for drug development, clinical research, and evidence synthesis.

Writing & Docsscripts

handling-sf-data

Included

Salesforce data operations with 130-point scoring. Use this skill to create, update, delete, bulk import/export, generate test data, and clean up org records using sf CLI and anonymous Apex. TRIGGER when: user creates test data, performs bulk import/export, uses sf data CLI commands, needs data factory patterns for Apex tests, or needs to seed/clean records in a Salesforce org. DO NOT TRIGGER when: SOQL query writing only (use querying-soql), Apex test execution (use running-apex-tests), or metadata deployment (use deploying-metadata).

Writing & Docsscripts

accelint-ac-to-playwright

Included

Convert and validate acceptance criteria for Playwright test automation. Use when user asks to (1) review/evaluate/check if AC are ready for automation, (2) assess if AC can be converted as-is, (3) validate AC quality for Playwright, (4) turn AC into tests, (5) generate tests from acceptance criteria, (6) convert .md bullets or .feature Gherkin files to Playwright specs, (7) create test automation from requirements. Handles both bullet-style markdown and Gherkin syntax with JSON test plan generation and validation.

Writing & Docsscripts