Template Dokumentasi

Mulai lebih cepat dengan template siap pakai untuk API docs, panduan how‑to, ADR, incident, dan lainnya.

Library Template

API Endpoint Guide

Use when documenting an important endpoint that other teams will call frequently.

# Endpoint: `GET /resource/{id}`

## 1. Overview
- **Purpose**:  
- **Audience**: Backend / Frontend / External integrators  
- **Owner**:

## 2. Authentication & Permissions
- **Auth required**: Yes/No  
- **Scopes/Roles**:

## 3. Request

### 3.1 Path Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id   | string | yes | Resource identifier |

### 3.2 Query Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|

### 3.3 Headers
| Name | Required | Description |
|------|----------|-------------|

### 3.4 Request Body
- **Content-Type**: `application/json`  
- **Schema**:  
```json
{
  "exampleField": "value"
}
```

## 4. Responses

### 4.1 200 OK
- **Description**:  
```json
{
  "id": "123",
  "exampleField": "value"
}
```

### 4.2 Error Responses
| Status | Error Code | When | Example |
|--------|------------|------|---------|
| 400 |  |  |  |
| 401 |  |  |  |
| 404 |  |  |  |

## 5. Usage Examples

### 5.1 cURL
```bash
curl -X GET "https://api.example.com/resource/{id}" \
  -H "Authorization: Bearer <token>"
```

### 5.2 JavaScript (fetch)
```ts
const res = await fetch('https://api.example.com/resource/123', {
  headers: { Authorization: 'Bearer token' },
})
const data = await res.json()
```

## 6. Notes & Edge Cases
-

## 7. Change Log
| Version | Date | Change | Author |
|---------|------|--------|--------|
| 1.0.0 | YYYY-MM-DD | Initial version | |

Cara Menggunakan Alat Ini

Pilih Template

Pilih jenis dokumentasi yang sesuai, misalnya API guide atau ADR.

Sesuaikan Konten

Edit outline Markdown, isi setiap bagian, dan sesuaikan strukturnya dengan proyek Anda.

Salin atau Unduh

Salin hasilnya atau unduh sebagai file .md lalu tempel di repo, wiki, atau platform dokumentasi.

Tips Profesional

• Gunakan satu template per jenis dokumen agar tim cepat mengenali polanya.
• Link dokumen ini dari README, API docs, atau dashboard supaya mudah ditemukan.
• Anggap template sebagai dokumen hidup — perbarui saat kebutuhan tim berubah.
• Gunakan heading yang konsisten agar pencarian di codebase / knowledge base lebih efektif.