documentation

name	documentation
description	Dokumentazio teknikoa sortzea eta mantentzea - README, API, gidak eta tutorialak

Zer egiten dudan

Dokumentazio tekniko argi, oso eta erabilgarria sortu eta mantentzen dut.

Noiz erabili

• Proiektu README sortu edo eguneratzeko
• API-ak dokumentatzeko (REST, GraphQL, etab.)
• Onboarding gidak idazteko
• Erabaki teknikoak dokumentatzeko (ADR)
• Pausoz-pausoko tutorialak sortzeko
• Changelog-ak mantentzeko

READMEren egitura

# Proiektuaren Izena

Deskribapen laburra (1-2 esaldi).

## Quick Start
<5 minututan hasteko kodea.

## Instalazioa
Aurretiko betekizunak → Instalazio urratsak.

## Erabilera
Oinarrizko adibideak → Aurreratuak.

## Konfigurazioa
Environment aldagaiak → Konfigurazio aukerak.

## API (aplikatzen bada)
Endpoint → Metodoa → Deskribapena → Adibidea.

## Contributing
Nola lagundu → Gidalerroak → Jokabide kodea.

## Lizentzia

API dokumentazioa

REST

### Endpoint

**Metodoa:** GET/POST/PUT/DELETE

**URL:** `/api/resource`

**Header-ak:**
- `Authorization: Bearer <token>`
- `Content-Type: application/json`

**Body (aplikatzen bada):**
```json
{
  "field": "description"
}

Erantzunak:

• 200 OK - Deskribapena
• 400 Bad Request - Balioztapena huts egin du
• 401 Unauthorized - Auth gabe
• 404 Not Found - Baliabidea ez da existitzen
• 500 Server Error - Barneko errorea

Adibidea:

curl -X GET "https://api.example.com/resource"

## Gida estilistikoa

1. **Bigarren pertsona erabili** - "Zu" ez "gu"
2. **Aginduzko aditza** - "Exekutatu" ez "Exekutatzen"
3. **Laburra eta fokatua** - Kontzeptu bat atal bakoitzean
4. **Kode blokeak hizkuntzarekin** - Hizkuntza zehaztu
5. **Irudiak lagungarri direnean** - Pantaila-argazkiak, diagramak
6. **Eguneratuta mantendu** - Zaharkitutako docs-ik ez = docs ez izatea baino okerragoa

## Dokumentazio motak

| Mota | Audientzia | Xehetasuna | Adibidea |
|------|----------|-----------|--------|
| Tutoriala | Erabiltzaile berriak | Pausoz-pauso | "Nola sortu zure lehena..." |
| Gida | Erabiltzaile ertainak | Kontzeptu giltzarrapekoak | "JWT-rekin autentifikazioa" |
| Erreferentzia | Developer-ak | Xehetasun teknikoak | API docs |
| Azalpena | Denak | Kontzeptuak | "X nola funtzionatzen duen" |
| Troubleshooting | Arazoak dituztenak | Soluzioak | "Ohiko erroreak" |