無料GitHub で公開

onboard

Generate project onboarding guide: stack, setup instructions, structure, conventions, useful links.

日本語の概要は準備中です。原文の説明を表示しています。

SebastianLuser/claude-code-arcaneスター 3(GitHub 3 + cccskills 0)

実行スコア未検証

インストール方法を見る

含まれるファイル（1）

SKILL.md2.6 KB

SKILL.md（原文）

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Onboarding Guide Generator

Genera una guía completa para que un dev nuevo pueda arrancar a trabajar en el proyecto.

Process

1. Escanear proyecto

Leer en paralelo:

README.md, CONTRIBUTING.md, CLAUDE.md
Package manager config (go.mod, package.json, pyproject.toml, etc.)
Docker config (Dockerfile, docker-compose.yml)
CI config (.github/workflows/)
.env.example
Makefile / scripts/
Estructura de carpetas (2-3 niveles)

2. Generar guía

# Guía de Onboarding — [Proyecto]
**Última actualización:** [fecha]

## Qué es este proyecto
[1-2 párrafos: qué hace, para quién, por qué existe]

## Stack tecnológico
| Componente | Tecnología | Versión |
|------------|------------|---------|
| Lenguaje | Go 1.26 | 1.26.1 |
| Framework | Gin | 1.12.0 |
| Base de datos | PostgreSQL | 16 |
| ORM | GORM | 1.31.1 |

## Prerequisitos
- [ ] [Tool 1] instalado (link a docs)
- [ ] [Tool 2] instalado
- [ ] Acceso a [servicio] (pedir a [persona])

## Setup paso a paso

### 1. Clonar y configurar
```bash
git clone [repo-url]
cd [proyecto]
cp .env.example .env
# Editar .env con tus valores

2. Levantar servicios

[comando para DB, docker, etc.]

3. Instalar dependencias

[go mod download / npm install / etc.]

4. Correr migrations

[comando de migrations]

5. Arrancar el servidor

[comando para development server]

6. Verificar que funciona

curl http://localhost:[port]/health
# Debe responder: {"status": "ok"}

Estructura del proyecto

[árbol de directorios con descripción de cada carpeta]

Convenciones de código

[Naming, estructura de archivos, patrones usados]

Comandos útiles

Comando	Qué hace
`make test`	Correr tests
`make lint`	Lint
`make build`	Build

Git workflow

Branches: [convención]
Commits: [formato]
PRs: [proceso]

Links útiles

Jira: [link]
Figma: [link]
Staging: [link]
Docs: [link]

Contactos

Área	Persona	Contacto


### 3. Output

Guardar como `docs/ONBOARDING.md` o `ONBOARDING.md` en la raíz.

## Rules
- Solo incluir info que se puede verificar del código actual
- Si falta info (como links a staging), dejar placeholder con [TODO]
- Probar mentalmente que los pasos de setup funcionan en orden
- En español

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

ログインなしで書き込めます。使ってみた感想、質問、動かなかった環境などを気軽にどうぞ。

まだコメントはありません。最初のコメントを書いてみませんか。

同じリポジトリのスキル

ab-test-setup

無料

Plan, design, and implement A/B tests and experiments with statistical rigor. Covers hypothesis frameworks, sample sizing, metrics, and result analysis.

日本語の概要は準備中です。原文の説明を表示しています。