Amanoba Logo
Back to Course

Dasar dokumentasi

Day 20 of 30 · AI Generatif 2026: Bangun Aplikasi AI dan Agen

One-liner: Tulis dokumentasi ringkas yang memudahkan pengguna memulai.
Time: 20 hingga 30 menit
Deliverable: Ringkasan Dokumentasi dan Quickstart

Learning goal

You will be able to: Menulis dokumentasi dasar agar pengguna cepat mulai.

Success criteria (observable)

  • Ada quickstart dengan 5 langkah.
  • Requirements ditulis jelas.
  • Ada satu contoh penggunaan.

Output you will produce

  • Deliverable: Ringkasan Dokumentasi dan Quickstart
  • Format: Dokumen satu halaman
  • Where saved: Di folder kursus dalam /generative-ai-2026-build-ai-apps-and-agents-id/

Who

Primary persona: Digital nomad yang menulis dokumentasi produk Secondary persona(s): Pengguna baru yang ingin cepat mulai Stakeholders (optional): Mitra pembangunan

What

What it is

Dokumentasi ringkas yang menjelaskan cara memulai memakai app. Mencakup requirements, langkah quickstart, dan contoh penggunaan.

What it is not

Bukan buku teknis yang panjang. Bukan dokumen tanpa struktur.

2-minute theory

  • Dokumentasi ringkas mempercepat onboarding.
  • Quickstart menunjukkan langkah penting saja.
  • Contoh penggunaan lebih efektif daripada penjelasan panjang.

Key terms

  • Quickstart: Langkah singkat untuk mulai menggunakan produk.
  • Requirements: Hal yang dibutuhkan sebelum mulai.

Where

Applies in

  • README
  • Help center

Does not apply in

  • Dokumentasi internal saja

Touchpoints

  • Halaman dokumentasi
  • Langkah setup
  • Contoh penggunaan

When

Use it when

  • Anda ingin pengguna cepat mulai
  • Anda meluncurkan fitur baru

Frequency

Revisi setiap perubahan besar

Late signals

  • Pengguna bertanya “mulai dari mana?”
  • Onboarding terlalu lama

Why it matters

Practical benefits

  • Onboarding lebih cepat
  • Tiket support berkurang
  • Kepercayaan meningkat

Risks of ignoring

  • Pengguna pergi sebelum mencoba
  • Review buruk

Expectations

  • Improves: kecepatan onboarding
  • Does not guarantee: retensi jangka panjang

How

Step-by-step method

  1. Tulis requirements penting.
  2. Buat 5 langkah quickstart.
  3. Tambahkan contoh penggunaan.
  4. Tambahkan bagian “Common issues”.
  5. Uji dengan satu pengguna baru.

Do and don't

Do

  • Gunakan bahasa sederhana
  • Buat langkah singkat

Don't

  • Menulis paragraf panjang tanpa struktur
  • Mengabaikan requirements

Common mistakes and fixes

  • Mistake: Tidak ada quickstart. Fix: Tambahkan 5 langkah.
  • Mistake: Requirements tidak jelas. Fix: Tulis dalam poin.

Done when

  • Quickstart 5 langkah selesai.
  • Requirements ditulis.
  • Contoh penggunaan ada.

Guided exercise (10 to 15 min)

Inputs

  • Deskripsi produk
  • Requirements utama

Steps

  1. Tulis requirements dalam poin.
  2. Buat 5 langkah quickstart.
  3. Tambahkan contoh penggunaan.

Output format

Field Value
Requirements
Quickstart steps
Example usage
Common issues

Pro tip: Tulis quickstart untuk pengguna yang benar benar baru.

Independent exercise (5 to 10 min)

Task

Pangkas quickstart menjadi 4 langkah tanpa mengurangi makna.

Output

Quickstart yang disederhanakan.

Self-check (yes/no)

  • Apakah requirements ditulis?
  • Apakah quickstart punya 5 langkah?
  • Apakah ada contoh penggunaan?
  • Apakah bahasanya mudah?

Baseline metric (recommended)

  • Score: 3 dari 4 terpenuhi
  • Date: 2026-02-07
  • Tool used: Notes app

Bibliography (sources used)

  1. Documentation Best Practices. GitHub. 2024-01-01. Read: https://docs.github.com/

  2. Writing Docs for Users. Google. 2024-01-01. Read: https://developers.google.com/tech-writing

Read more (optional)

  1. README Checklist Why: Pastikan dokumentasi Anda solid. Read: https://www.makeareadme.com/