onboarding-docs

What this skill does

# Onboarding Documentation Skill

## When to Use This Skill

Use this skill when:

- **Onboarding Docs tasks** - Working on developer onboarding documentation and learning paths
- **Planning or design** - Need guidance on Onboarding Docs approaches
- **Best practices** - Want to follow established patterns and standards

## Overview

Create comprehensive developer onboarding documentation for accelerated productivity.

## MANDATORY: Documentation-First Approach

Before creating onboarding docs:

1. **Invoke `docs-management` skill** for onboarding patterns
2. **Verify developer experience best practices** via MCP servers (perplexity)
3. **Base guidance on industry onboarding standards**

## Onboarding Documentation Framework

```text
Onboarding Documentation Layers:

┌─────────────────────────────────────────────────────────────────────────────┐
│  Day 1: Environment Setup                                                    │
│  • Development environment installation                                      │
│  • Access provisioning and credentials                                       │
│  • Tool configuration                                                        │
├─────────────────────────────────────────────────────────────────────────────┤
│  Week 1: Core Concepts                                                       │
│  • Architecture overview                                                     │
│  • Codebase orientation                                                      │
│  • Development workflow                                                      │
├─────────────────────────────────────────────────────────────────────────────┤
│  Month 1: Deep Dive                                                          │
│  • Domain knowledge                                                          │
│  • System internals                                                          │
│  • Advanced workflows                                                        │
├─────────────────────────────────────────────────────────────────────────────┤
│  Ongoing: Reference Materials                                                │
│  • API documentation                                                         │
│  • Runbooks and procedures                                                   │
│  • Best practices and standards                                              │
└─────────────────────────────────────────────────────────────────────────────┘
```

## Onboarding Guide Template

````markdown
# Developer Onboarding Guide

Welcome to [Project/Team Name]! This guide will help you get productive quickly.

---

## Quick Links

| Resource | Link | Purpose |
|----------|------|---------|
| Codebase | [GitHub Repo] | Source code |
| Documentation | [Docs Site] | Technical docs |
| Issue Tracker | [Jira/GitHub] | Tasks and bugs |
| CI/CD | [Azure DevOps/GitHub Actions] | Build pipelines |
| Monitoring | [Grafana/DataDog] | Metrics and alerts |
| Chat | [Slack/Teams] | Team communication |

---

## Day 1 Checklist

### Access Setup

- [ ] GitHub organization invite accepted
- [ ] Azure subscription access granted
- [ ] Slack/Teams workspace joined
- [ ] VPN configured (if applicable)
- [ ] Password manager setup
- [ ] MFA enabled on all accounts

### Development Environment

- [ ] IDE installed and configured
- [ ] Required SDKs installed
- [ ] Repository cloned
- [ ] Project builds locally
- [ ] Tests run successfully

### First Steps

- [ ] Read this onboarding guide
- [ ] Review team conventions
- [ ] Meet your onboarding buddy
- [ ] Schedule 1:1 with team lead

---

## Environment Setup

### Prerequisites

| Tool | Version | Installation |
|------|---------|--------------|
| .NET SDK | 10.0+ | [Download](https://dot.net) |
| Node.js | 22 LTS | [Download](https://nodejs.org) |
| Docker Desktop | Latest | [Download](https://docker.com) |
| Git | 2.40+ | [Download](https://git-scm.com) |
| VS Code / Rider | Latest | IDE of choice |

### Step-by-Step Setup

#### 1. Install Prerequisites

**Windows (winget):**
```powershell
winget install Microsoft.DotNet.SDK.10
winget install OpenJS.NodeJS.LTS
winget install Docker.DockerDesktop
winget install Git.Git
winget install Microsoft.VisualStudioCode
```

**macOS (Homebrew):**

```bash
brew install --cask dotnet-sdk
brew install node@22
brew install --cask docker
brew install git
brew install --cask visual-studio-code
```

#### 2. Clone Repository

```bash
# Clone the main repository
git clone https://github.com/org/project.git
cd project

# Install dependencies
dotnet restore
npm install
```

#### 3. Configure Environment

```bash
# Copy environment template
cp .env.example .env.local

# Edit with your values
code .env.local
```

**Required Environment Variables:**

| Variable | Description | How to Get |
|----------|-------------|------------|
| `DATABASE_URL` | PostgreSQL connection | Use local Docker or dev DB |
| `AZURE_CLIENT_ID` | Azure service principal | Request from team lead |
| `API_KEY` | External API key | 1Password vault |

#### 4. Start Development Environment

```bash
# Start infrastructure (database, cache, etc.)
docker compose up -d

# Run database migrations
dotnet ef database update

# Start the application
dotnet run
```

#### 5. Verify Setup

```bash
# Run tests
dotnet test

# Check API health
curl http://localhost:5000/health
```

**Expected Output:**

```json
{
  "status": "Healthy",
  "checks": {
    "database": "Healthy",
    "cache": "Healthy"
  }
}
```

---

## Architecture Overview

### System Context

[Include C4 Context Diagram]

### High-Level Architecture

```text
┌─────────────────────────────────────────────────────────────────────────────┐
│                              Load Balancer                                   │
└─────────────────────────────────────────────────────────────────────────────┘
                                     │
                    ┌────────────────┼────────────────┐
                    ▼                ▼                ▼
            ┌──────────────┐ ┌──────────────┐ ┌──────────────┐
            │   Web App    │ │   API        │ │   Worker     │
            │   (Blazor)   │ │   (.NET)     │ │   Service    │
            └──────────────┘ └──────────────┘ └──────────────┘
                    │                │                │
                    └────────────────┼────────────────┘
                                     ▼
                         ┌─────────────────────┐
                         │     PostgreSQL      │
                         └─────────────────────┘
```

### Key Components

| Component | Purpose | Tech Stack |
|-----------|---------|------------|
| Web App | User interface | Blazor, Tailwind CSS |
| API | Backend services | .NET 10, Minimal APIs |
| Worker | Background jobs | .NET Worker Service |
| Database | Data persistence | PostgreSQL 16 |
| Cache | Performance | Redis |
| Queue | Async messaging | Azure Service Bus |

---

## Codebase Orientation

### Repository Structure

```text
project/
├── src/
│   ├── Web/                    # Blazor frontend
│   ├── Api/                    # Backend API
│   ├── Worker/                 # Background services
│   └── SharedKernel/           # Shared code
├── tests/
│   ├── Unit/                   # Unit tests
│   ├── Integration/            # Integration tests
│   └── E2E/                    # End-to-end tests
├── docs/                       # Documentation
├── scripts/                    # Utility scripts
├── .github/                    # GitHub workflows
└── docker-compose.yml          # Local development
```

### Key Files to Review

| File | Purpose | Priority |
|------|---------|----------|
| `README.md` | Project overview | Day 1 |
| `CONTRIBUTING.md` | Contribution guidelines | Day 1 |
| `src/Api/Program.cs` | API entry point | Week 1 |
| `src/SharedKernel/Domain/` | Domain models | Week 1 |
| `docs/architecture/` | Architecture docs | Week 1 |

### Code Conventions

**Naming:**

- Classes: `PascalCase`
- Met