Misingi ya documentation

One-liner: Andika nyaraka fupi zinazoonyesha jinsi app inavyotumika.
Time: 20 hadi 30 dakika
Deliverable: Muhtasari wa Documentation na Quickstart

Learning goal

You will be able to: Kuandika documentation ya msingi inayowezesha mtumiaji kuanza.

Success criteria (observable)

• Kuna quickstart yenye hatua 5.
• Requirements zimeandikwa wazi.
• Mfano mmoja wa matumizi upo.

Output you will produce

• Deliverable: Muhtasari wa Documentation na Quickstart
• Format: Hati ya ukurasa mmoja
• Where saved: Kwenye folda ya kozi ndani ya /generative-ai-2026-build-ai-apps-and-agents-sw/

Who

Primary persona: Digital nomad anayebandika nyaraka kwa bidhaa Secondary persona(s): Watumiaji wapya wanaotaka kuanza haraka Stakeholders (optional): Washirika wa ujenzi

What

What it is

Nyaraka fupi zinazoeleza jinsi ya kuanza kutumia app. Inajumuisha requirements, hatua za kuanza, na mfano wa matumizi.

What it is not

Si kitabu kirefu cha kiufundi. Si nyaraka zisizo na muundo.

2-minute theory

• Documentation fupi hupunguza muda wa kuanza.
• Quickstart inaonyesha hatua muhimu pekee.
• Mfano mmoja wa matumizi ni bora kuliko maelezo marefu.

Key terms

• Quickstart: Hatua fupi za kuanza kutumia bidhaa.
• Requirements: Vitu vinavyohitajika kabla ya kuanza.

Where

Applies in

• README
• Help center

Does not apply in

• Nyaraka za ndani tu zisizotolewa kwa watumiaji

Touchpoints

• Documentation page
• Setup steps
• Example usage

When

Use it when

• Unataka watumiaji waanze haraka
• Unazindua feature mpya

Frequency

Rekebisha kila mabadiliko ya bidhaa

Late signals

• Watumiaji wanauliza “ninaanzia wapi?”
• Muda wa kuanza ni mrefu sana

Why it matters

Practical benefits

• Onboarding ya haraka
• Maswali ya support yanapungua
• Uaminifu wa bidhaa unaongezeka

Risks of ignoring

• Watumiaji kuacha kabla ya kujaribu
• Tathmini mbaya

Expectations

• Improves: kuanza kwa haraka na uelewa
• Does not guarantee: retention ya muda mrefu

How

Step-by-step method

1. Andika requirements muhimu.
2. Andika hatua 5 za quickstart.
3. Ongeza mfano mmoja wa matumizi.
4. Ongeza sehemu ya “Common issues”.
5. Pitia na mtu mmoja asiyefahamu bidhaa.

Do and don't

Do

• Andika kwa lugha rahisi
• Tumia hatua fupi

Don't

• Kuandika maandiko marefu bila muundo
• Kutoa hatua zisizo na mpangilio

Common mistakes and fixes

• Mistake: Hakuna quickstart. Fix: Ongeza hatua 5.
• Mistake: Requirements haziko wazi. Fix: Ziorodheshe kwa pointi.

Done when

• Quickstart ipo na hatua 5.
• Requirements zimeandikwa.
• Mfano mmoja wa matumizi upo.

Guided exercise (10 to 15 min)

Inputs

• Maelezo ya bidhaa
• Requirements muhimu

Steps

1. Andika requirements kwa pointi.
2. Andika hatua 5 za quickstart.
3. Ongeza mfano wa matumizi.

Output format

Field	Value
Requirements
Quickstart steps
Example usage
Common issues

Pro tip: Andika quickstart kwa mtumiaji mpya kabisa.

Independent exercise (5 to 10 min)

Task

Punguza quickstart hadi hatua 4 bila kupoteza maana.

Output

Quickstart iliyofupishwa na iliyo wazi.

Self-check (yes/no)

• Je, requirements zimeandikwa?
• Je, quickstart ina hatua 5?
• Je, mfano wa matumizi upo?
• Je, lugha ni rahisi?

Baseline metric (recommended)

• Score: Hatua 3 kati ya 4 zimekamilika
• 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: Hakikisha nyaraka zako zina msingi thabiti. Read: https://www.makeareadme.com/