Programeri primaju velik broj bug reportova koji se sastoje samo od slike i riječi “ne radi”. Snimka zaslona obavlja pola posla, a druga polovica ovisi o tome kako je snimljena, označena i priložena. Ovaj vodič je praktičan predložak kojim snimka zaslona dobiva punu vrijednost.

Što sadrži dobar report temeljen na snimci zaslona

  1. Samo stanje: stvarni zaslon koji prikazuje problem, a ne njegov opis.
  2. Pokazivač: strelica ili okvir koji označava točan element o kojem je riječ.
  3. Kontekst: koja aplikacija i koji build, koji operacijski sustav i po mogućnosti rezolucija, kako bi programer mogao isključiti prikaz specifičan za okruženje.
  4. Koraci reprodukcije: numerirani, kratki i redom. Snimka je korak N, a čitatelju trebaju koraci od 1 do N-1.
  5. Očekivano i stvarno: po jedan redak. “Očekivano: padajući izbornik ostaje otvoren. Stvarno: izbornik se odmah zatvara.”

Sve ostalo je neobavezno. Odolite želji da priložite pet snimki kad cijelu priču ispriča jedna označena snimka i tri koraka reprodukcije.

Snimanje posebno za bug report

Odaberite pravi opseg

  • Područje umjesto cijelog zaslona, u većini slučajeva. Uska snimka oko neispravne komponente brže se čita na mobitelu i otkriva manje vašeg okruženja.
  • Cijeli zaslon samo kad je položaj važan, na primjer kod greške u rasporedu, gdje je odnos između panela upravo ono o čemu je riječ.
  • Snimite oba stanja kod grešaka pri prijelazu. Ako klik na X uzrokuje nestanak Y-a, trebate stanje prije i poslije. Dvije male snimke bolje su od jedne dvosmislene.

Označavajte s namjerom

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

Oznaka Kada je koristiti
Strelica Pogrešan je jedan konkretan element. Zadani izbor.
Pravokutnik Područje ili kontejner se loše ponaša (razmaci, preljev, odsijecanje).
Tekst Brojevi koraka u reprodukciji s više koraka; oznake “očekivano” i “stvarno”.
Zamagljivanje Sve osjetljivo što nije bitno za grešku. Uvijek.
Obreži Uklonite prazan prostor nakon označavanja da oznaka dođe do izražaja.

Dva praktična pravila:

  • Jedna strelica po snimci. Ako trebate tri strelice, vjerojatno trebate tri snimke.
  • Zamaglite prije otpreme. Tokeni, imena kupaca i interni URL-ovi zamagljuju se u uređivaču prije nego što slika napusti vaše računalo. Koju vrstu prekrivanja odabrati ovisi o tome što mora ostati čitljivo. Nakon dijeljenja zamagljivanje se ne može poništiti.

Uključite metapodatke koji pomažu

Stranica za dijeljenje koja prikazuje dimenzije, veličinu datoteke i datum snimanja uklanja jedan krug pitanja “u kojoj ste rezoluciji bili?”. Shotivove stranice za dijeljenje prikazuju širinu × visinu, veličinu datoteke, datum nastanka i istek, pa lijepljenje linka automatski prenosi taj kontekst.

U samom tekstu reporta dodajte:

  • Naziv aplikacije i verziju (npr. “Shotivo 1.x” ili broj builda zahvaćenog proizvoda)
  • OS i verziju (“macOS 15.2”)
  • Jednu rečenicu o okruženju ako je bitna (“vanjski 4K zaslon”, “VPN uključen”)

Postupak: tri sekunde do snimke spremne za dijeljenje

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

  1. ⌘⇧9: povucite preko neispravnog područja. Uređivač se otvara odmah.
  2. Kliknite alat Strelica i označite element, zamaglite sve osjetljivo i obrežite usko.
  3. ⌘↩ (Podijeli): otprema sliku i kopira link shotivo.app/s/… u međuspremnik.
  4. Zalijepite link u tiket, a iza njega napišite korake reprodukcije.

Ukupno od prvog pritiska tipke do linka spremnog za lijepljenje: otprilike tri do pet sekundi. Besplatni linkovi istječu nakon 7 dana, a Pro linkovi mogu ostati aktivni do 90 dana (zadano 90 dana). Ako tiket treba trajnu lokalnu kopiju, preuzmite original. Ako niste sigurni koje ograničenje vrijedi za vas, pogledajte kako zadržavanje funkcionira po razinama.

Predložak

[Aplikacija] [Komponenta] · [sažetak u jednom retku]

Koraci:
1. …
2. …
3. Uočeno: <što se događa>

Očekivano: <što bi se trebalo dogoditi>

Snimka zaslona: <zalijepite link za dijeljenje>
Okruženje: macOS 15.2 · build aplikacije 1.x · <napomena o zaslonu ako je bitna>

Ispunite predložak za manje od minute i dobit ćete report na koji programer može reagirati bez dodatnog poziva. Snimka zaslona pokazuje problem, a tri retka teksta objašnjavaju kako do njega doći.

Česte greške

  • “Vidi privitak.” bez koraka reprodukcije. Programer mora pogađati put do tog stanja.
  • Snimka cijelog zaslona za sitan problem. Strelica pokazuje na 2% kadra.
  • Nezamagljene tajne. Report se proslijedi, arhivira i indeksira, a vaš token je odjednom javan.
  • Pet snimki istog stanja. Jedna dobra snimka uz opis bolja je od pet osrednjih.
  • Snimka napravljena nakon “popravka”. Prvo snimite neispravno stanje; kasnije uvijek možete snimiti ponovno.

Prag je nizak i vrijedi ga zadovoljiti: može li programer koji nikad nije vidio ovu aplikaciju doći do neispravnog stanja samo iz vašeg teksta i na vašoj slici vidjeti što je točno pogrešno? Ako može, report je gotov.