Programeri dobijaju veliki deo bug reporta koji su samo slika i reči “ne radi”. Snimak obavlja pola posla; drugu polovinu čini način na koji je snimljen, označen i upakovan. Ovaj vodič je praktičan šablon da snimci nose punu težinu.

Šta sadrži dobar izveštaj zasnovan na snimku

  1. Samo stanje: stvarni ekran koji pokazuje problem, a ne njegov opis.
  2. Pokazivač: strelica ili okvir koji označava tačan element o kojem je reč.
  3. Kontekstualni metapodaci: koja aplikacija/build, koji OS i, poželjno, rezolucija, da programer može da isključi greške u prikazu koje zavise od okruženja.
  4. Koraci reprodukcije: numerisani, kratki, redom. Snimak je korak N; čitaocu trebaju koraci od 1 do N-1.
  5. Očekivano naspram stvarnog: po jedna linija. “Očekivano: padajući meni ostaje otvoren. Stvarno: padajući meni se odmah zatvara.”

Sve ostalo je opciono. Odupri se želji da priložiš pet snimaka kad celu priču ispriča jedan označen snimak i tri koraka reprodukcije.

Snimanje posebno za bug report

Izaberi pravi obuhvat

  • Oblast, a ne ceo ekran, u većini slučajeva. Uzak isečak oko komponente koja ne radi čita se brže na telefonu i izlaže manje tvog okruženja.
  • Ceo ekran samo kad je bitna pozicija, na primer kod greške u rasporedu gde je odnos između panela upravo poenta.
  • Snimi oba stanja kod grešaka u prelazu. Ako klik na X čini da Y nestane, treba ti i pre i posle. Dva mala snimka vrede više od jednog dvosmislenog.

Označi sa namerom

Vodič za označavanje detaljno opisuje alate; za izveštaj ti uglavnom treba:

Oznaka Kada je koristiti
Strelica Jedan konkretan element je pogrešan. Podrazumevani izbor.
Pravougaonik Oblast ili kontejner se loše ponaša (razmaci, prelivanje, odsecanje).
Tekst Brojevi koraka u reprodukcijama sa više koraka; oznake “očekivano” i “stvarno”.
Zamućenje Sve osetljivo što nije bitno za grešku. Uvek.
Izreži Ukloni prazan prostor posle označavanja da oznaka nosi kadar.

Dva pravila iz prakse:

  • Jedna strelica po snimku. Ako ti trebaju tri strelice, verovatno ti trebaju tri snimka.
  • Zamuti pre otpremanja. Tokeni, imena klijenata i interni URL-ovi zamućuju se u editoru pre nego što slika napusti tvoju mašinu. Koji način prekrivanja izabrati zavisi od toga šta mora ostati čitljivo. Posle deljenja ne postoji način da se zamućenje poništi.

Uključi metapodatke koji pomažu

Stranica za deljenje koja prikazuje dimenzije, veličinu fajla i datum snimanja štedi jedan krug pitanja “na kojoj rezoluciji si bio?”. Stranice za deljenje u Shotivu prikazuju širinu × visinu, veličinu fajla, datum kreiranja i istek, pa lepljenje linka automatski prenosi taj kontekst.

U samom tekstu izveš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 liniju o okruženju ako je bitno (“eksterni 4K monitor”, “VPN uključen”)

Tok rada: tri sekunde do snimka spremnog za deljenje

Sa alatom za snimanje u traci menija (prikazane su podrazumevane Shotivo prečice):

  1. ⌘⇧9: prevuci preko oblasti koja ne radi. Editor se otvara odmah.
  2. Klikni alat strelica, označi element; zamuti sve osetljivo; izreži usko.
  3. ⌘↩ (Podeli): otprema sliku i kopira shotivo.app/s/… link u klipbord.
  4. Nalepi link u tiket, a posle njega korake reprodukcije.

Ukupno od prvog pritiska tastera do linka spremnog za lepljenje: otprilike tri do pet sekundi. Besplatni linkovi ističu posle 7 dana; Pro linkovi mogu ostati aktivni do 90 dana (podrazumevano 90 dana). Ako tiket treba da ima trajnu lokalnu kopiju, preuzmi original. Kako zadržavanje funkcioniše po nivoima ako nisi siguran koje ograničenje važi za tebe.

Šablon

[Aplikacija] [Komponenta] · [sažetak u jednoj liniji]

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

Očekivano: <šta bi trebalo da se desi>

Snimak: <nalepi link za deljenje>
Okruženje: macOS 15.2 · build aplikacije 1.x · <napomena o ekranu ako je bitna>

Ispuni šablon za manje od minuta i izveštaj je spreman: programer može da reaguje na njega bez dodatnog poziva. Snimak pokazuje, a te tri linije objašnjavaju.

Česte greške

  • “Vidi prilog.” bez koraka reprodukcije. Programer mora da pogađa put do tog stanja.
  • Snimak celog ekrana zbog sitnog problema. Strelica pokazuje na 2% kadra.
  • Nezamućene tajne. Izveštaj se prosleđuje, arhivira, indeksira; tvoj token je sada javan.
  • Pet snimaka istog stanja. Jedan dobar snimak plus reči vredi više od pet osrednjih.
  • Snimak napravljen posle “popravke”. Prvo snimi stanje u kojem ne radi; uvek možeš da snimiš ponovo kasnije.

Prag je nizak i vredi ga preći: može li programer koji nikad nije video ovu aplikaciju da, samo na osnovu tvog teksta, stigne do neispravnog stanja i da na tvojoj slici tačno vidi šta nije u redu? Ako može, izveštaj je gotov.