Programeri primaju velik dio bug reporta koji su samo slika i riječi “ne radi”. Snimak ekrana radi pola posla, a druga polovina zavisi od toga kako je snimljen, označen i upakovan. Ovaj vodič je praktičan šablon da snimci ekrana ponesu svoj puni teret.

Šta dobar bug report zasnovan na snimku sadrži

  1. Samo stanje: stvarni ekran koji prikazuje problem, a ne njegov opis.
  2. Pokazivač: strelica ili okvir koji označava tačan element o kojem je riječ.
  3. Metapodaci o kontekstu: koja aplikacija i koji build, koji OS i, idealno, rezolucija, da programer može isključiti prikaz specifičan za okruženje.
  4. Koraci za reprodukciju: numerirani, kratki, po redu. Snimak je korak N, a čitaocu trebaju koraci od 1 do N-1.
  5. Očekivano naspram stvarnog: po jedna rečenica. “Očekivano: padajući meni ostaje otvoren. Stvarno: padajući meni se odmah zatvara.”

Sve ostalo je neobavezno. Odupri se želji da priložiš pet snimaka kad jedan označen snimak i tri koraka reprodukcije pričaju cijelu priču.

Snimanje posebno za bug report

Snimi pravi obuhvat

  • Područje, a ne cijeli ekran, u većini slučajeva. Uski izrez oko neispravne komponente brže se čita na mobitelu i otkriva manje tvog okruženja.
  • Cijeli ekran samo kad je bitan položaj, na primjer kod greške u rasporedu gdje je odnos između panela upravo problem.
  • Snimi oba stanja kod grešaka pri prijelazu. Ako klik na X učini da Y nestane, trebaju ti stanje prije i poslije. Dva mala snimka vrijede više od jednog nejasnog.

Označavaj s namjerom

Vodič za označavanje detaljno opisuje alate, a za bug report ti uglavnom trebaju ovi:

Oznaka Kad je koristiti
Strelica Jedan određen element je pogrešan. Zadani izbor.
Pravougaonik Područje ili kontejner se ponaša pogrešno (razmaci, preljev, odsijecanje).
Tekstualna oznaka Brojevi koraka u reprodukcijama s više koraka; napomene “očekivano” i “stvarno”.
Zamućenje Sve osjetljivo što nije bitno za grešku. Uvijek.
Izrezivanje Ukloni prazan prostor nakon označavanja da oznaka zauzme kadar.

Dva praktična pravila:

  • Jedna strelica po snimku. Ako ti trebaju tri strelice, vjerovatno ti trebaju tri snimka.
  • Zamuti prije slanja. Tokene, imena klijenata i interne URL-ove zamuti u editoru prije nego što slika napusti tvoj Mac. Koji način prekrivanja koristiti zavisi od toga šta mora ostati čitljivo. Nakon dijeljenja zamućenje se ne može poništiti.

Uključi metapodatke koji pomažu

Stranica za dijeljenje koja prikazuje dimenzije, veličinu datoteke i datum snimanja štedi jedan krug pitanja “koju rezoluciju si imao?”. Shotivove stranice za dijeljenje prikazuju širinu × visinu, veličinu datoteke, datum nastanka i istek, pa lijepljenje linka automatski prenosi taj kontekst.

U samo tijelo izvještaja dodaj:

  • Naziv aplikacije + verziju (npr. “Shotivo 1.x” ili broj builda proizvoda na koji se greška odnosi)
  • OS + verziju (“macOS 15.2”)
  • Jednu rečenicu o okruženju ako je bitna (“eksterni 4K monitor”, “VPN uključen”)

Tok rada: tri sekunde do snimka spremnog za dijeljenje

S alatom za snimanje u traci menija (prikazane su Shotivove zadane postavke):

  1. ⌘⇧9: povuci preko neispravnog područja. Editor se odmah otvara.
  2. Odaberi alat Strelica i označi element, zamuti sve osjetljivo, izreži usko.
  3. ⌘↩ (Podijeli): šalje sliku i kopira link shotivo.app/s/… u tvoj međuspremnik.
  4. Zalijepi link u tiket, a poslije njega korake reprodukcije.

Ukupno od prvog pritiska na tipku do linka spremnog za lijepljenje: otprilike tri do pet sekundi. Besplatni linkovi ističu nakon 7 dana, a Pro linkovi mogu ostati aktivni do 90 dana (zadano 90 dana). Preuzmi original ako tiketu treba trajna lokalna kopija. Ako nisi siguran koje ograničenje važi za tebe, pogledaj kako čuvanje linkova funkcioniše po nivoima.

Šablon

[Aplikacija] [Komponenta] · [sažetak u jednoj rečenici]

Koraci:
1. …
2. …
3. Primijeti: <šta se dešava>

Očekivano: <šta bi se trebalo desiti>

Snimak: <zalijepi link za dijeljenje>
Okruženje: macOS 15.2 · build aplikacije 1.x · <napomena o monitoru ako je bitna>

Ispuni šablon za manje od minute i dobit ćeš bug report na koji programer može reagovati bez dodatnog poziva. Snimak pokazuje, a te tri rečenice objašnjavaju.

Česte greške

  • “Vidi prilog.” bez koraka reprodukcije. Programer mora nagađati kako doći do tog stanja.
  • Snimak cijelog ekrana zbog sitnog problema. Strelica pokazuje na 2% kadra.
  • Nezamućene tajne. Bug report se proslijedi, arhivira i indeksira, a tvoj token je odjednom javan.
  • Pet snimaka istog stanja. Jedan dobar snimak uz objašnjenje vrijedi više od pet osrednjih.
  • Snimak napravljen nakon što si “popravio” grešku. Prvo snimi neispravno stanje, jer kasnije uvijek možeš snimiti ponovo.

Mjerilo je nisko i vrijedi ga zadovoljiti: može li programer koji nikad nije vidio ovu aplikaciju iz samog tvog teksta doći do neispravnog stanja, a sa tvoje slike vidjeti tačno šta nije u redu? Ako može, bug report je gotov.