# Onboarding Docs

> Developer Onboarding Documentation provides new team members with everything they need to become productive quickly. Good onboarding reduces time-to-first-commit from weeks to days. **Core Principle**

- Skill: `majiayu000/onboarding-docs-3` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds add majiayu000/onboarding-docs-3`
- Raw SKILL.md: https://api.skillmd.com/api/skills/majiayu000/onboarding-docs-3/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: majiayu000 (https://skillmd.com/u/majiayu000)
- Updated: 2026-09-09
- Page: https://skillmd.com/skills/majiayu000/onboarding-docs-3

---


# Onboarding Docs

## Skill Profile
*(Select at least one profile to enable specific modules)*
- [ ] **DevOps**
- [x] **Backend**
- [ ] **Frontend**
- [ ] **AI-RAG**
- [ ] **Security Critical**

## Overview
Developer Onboarding Documentation provides new team members with everything they need to become productive quickly. Good onboarding reduces time-to-first-commit from weeks to days.

**Core Principle**: "New developers should commit code on day 1, deploy to staging by day 3, and feel confident by week 2."

---

## Why This Matters
- **<Benefit>**: <short explanation>
- **<Benefit>**: <short explanation>
- **<Benefit>**: <short explanation>

## Core Concepts & Rules

### 1. Core Principles
- Follow established patterns and conventions
- Maintain consistency across codebase
- Document decisions and trade-offs

### 2. Implementation Guidelines
- Start with the simplest viable solution
- Iterate based on feedback and requirements
- Test thoroughly before deployment


## Inputs / Outputs / Contracts
* **Inputs**:
  - <e.g., env vars, request payload, file paths, schema>
* **Entry Conditions**:
  - <Pre-requisites: e.g., Repo initialized, DB running, specific branch checked out>
* **Outputs**:
  - <e.g., artifacts (PR diff, docs, tests, dashboard JSON)>
* **Artifacts Required (Deliverables)**:
  - <e.g., Code Diff, Unit Tests, Migration Script, API Docs>
* **Acceptance Evidence**:
  - <e.g., Test Report (screenshot/log), Benchmark Result, Security Scan Report>
* **Success Criteria**:
  - <e.g., p95 < 300ms, coverage ≥ 80%>

## Skill Composition
* **Depends on**: None
* **Compatible with**: None
* **Conflicts with**: None
* **Related Skills**: None

## Quick Start
\`\`\`bash
git clone https://github.com/company/project.git
cd project
npm run setup
npm run dev
\`\`\`
Visit http://localhost:3000

## Assumptions
- New developer has basic programming skills
- Company accounts are provisioned
- Hardware is provided
- Team has established practices

## Compatibility
- Works with any tech stack
- Language-agnostic principles
- Can be adapted to any team size

---

## Test Scenario Matrix
| Scenario | Expected Behavior | Notes |
|----------|-------------------|-------|
| New developer joins | Follow onboarding checklist | Buddy guides through process |
| First week | Complete graduated tasks | Build confidence gradually |
| Month 1 | Full team integration | Lead a feature end-to-end |
| Remote onboarding | Video-based onboarding | Use async communication |

---

## Technical Guardrails & Security Threat Model

### 1. Security & Privacy (Threat Model)
* **Top Threats**: Injection attacks, authentication bypass, data exposure
- [ ] **Data Handling**: Sanitize all user inputs to prevent Injection attacks. Never log raw PII
- [ ] **Secrets Management**: No hardcoded API keys. Use Env Vars/Secrets Manager
- [ ] **Authorization**: Validate user permissions before state changes

### 2. Performance & Resources
- [ ] **Execution Efficiency**: Consider time complexity for algorithms
- [ ] **Memory Management**: Use streams/pagination for large data
- [ ] **Resource Cleanup**: Close DB connections/file handlers in finally blocks

### 3. Architecture & Scalability
- [ ] **Design Pattern**: Follow SOLID principles, use Dependency Injection
- [ ] **Modularity**: Decouple logic from UI/Frameworks

### 4. Observability & Reliability
- [ ] **Logging Standards**: Structured JSON, include trace IDs `request_id`
- [ ] **Metrics**: Track `error_rate`, `latency`, `queue_depth`
- [ ] **Error Handling**: Standardized error codes, no bare except
- [ ] **Observability Artifacts**:
    - **Log Fields**: timestamp, level, message, request_id
    - **Metrics**: request_count, error_count, response_time
    - **Dashboards/Alerts**: High Error Rate > 5%


## Agent Directives & Error Recovery
*(ข้อกำหนดสำหรับ AI Agent ในการคิดและแก้ปัญหาเมื่อเกิดข้อผิดพลาด)*

- **Thinking Process**: Analyze root cause before fixing. Do not brute-force.
- **Fallback Strategy**: Stop after 3 failed test attempts. Output root cause and ask for human intervention/clarification.
- **Self-Review**: Check against Guardrails & Anti-patterns before finalizing.
- **Output Constraints**: Output ONLY the modified code block. Do not explain unless asked.


## Definition of Done
- [ ] README with quick start guide
- [ ] Architecture documentation with diagram
- [ ] Development workflow guide
- [ ] Troubleshooting guide
- [ ] Team practices documented
- [ ] Learning resources listed
- [ ] First week tasks defined
- [ ] Onboarding buddy guide
- [ ] Documentation checklist complete

---

## Anti-patterns / Pitfalls

* ⛔ **Don't**: Log PII, catch-all exception, N+1 queries
* ⚠️ **Watch out for**: Common symptoms and quick fixes
* 💡 **Instead**: Use proper error handling, pagination, and logging


## Reference Links
- [Onboarding Best Practices](https://hbr.org/topic/onboarding)
- [Developer Onboarding Guide](https://stackoverflow.blog/developer-onboarding-guide/)
- [Remote Onboarding Checklist](https://github.com/lukasz-madon/remote-onboarding-checklist)

---

## Versioning & Changelog

* **Version**: 1.0.0
* **Changelog**:
  - 2026-02-22: Initial version with complete template structure