Програмери добијају много пријава грешака које се састоје само од слике и речи „не ради“. Снимак обавља половину посла, а другу половину одређује начин на који је снимљен, означен и припремљен. Овај водич је практичан шаблон да твоји снимци дају све што могу.

Шта садржи добра пријава са снимком

  1. Само стање: прави екран који показује проблем, а не његов опис.
  2. Показивач: стрелица или оквир који означава тачно о ком елементу је реч.
  3. Метаподаци о контексту: која апликација и верзија, који оперативни систем и, ако је могуће, резолуција, да програмер може да искључи проблеме специфичне за окружење.
  4. Кораци за репродукцију: нумерисани, кратки, по редоследу. Снимак је корак N, а читаоцу су потребни кораци од 1 до N-1.
  5. Очекивано и стварно: по један ред за свако. „Очекивано: падајући мени остаје отворен. Стварно: падајући мени се одмах затвара.“

Све остало је необавезно. Одупри се жељи да приложиш пет снимака када једна означена слика и три корака за репродукцију причају целу причу.

Снимање специфично за пријаву грешке

Снимај право подручје

  • Регија, а не цео екран, у већини случајева. Уско исечен кадар око покварене компоненте брже се чита на телефону и открива мање твог окружења.
  • Цео екран само када је важан положај, на пример код грешке у распореду, где је однос између панела суштина проблема.
  • Снимај оба стања код грешака при преласку. Ако клик на X чини да Y нестане, потребни су ти снимци пре и после. Два мала снимка вреде више од једног који се може тумачити на два начина.

Означавај са сврхом

Водич за означавање детаљно описује алате, а за пријаву ти углавном требају:

Ознака Када је користити
Стрелица Један одређени елемент је погрешан. Подразумеван избор.
Правоугаоник Регија или контејнер се лоше понаша (размаци, прелив, одсецање).
Текстуална ознака Бројеви корака у репродукцији са више корака; напомене „очекивано“ и „стварно“.
Замагљење Све осетљиво што није важно за грешку. Увек.
Исеци Уклони празан простор после означавања да ознака заузме већи део кадра.

Два практична правила:

  • Једна стрелица по снимку. Ако ти требају три стрелице, вероватно ти требају три снимка.
  • Замагли пре отпремања. Токене, имена клијената и интерне URL-ове замагли у уређивачу пре него што слика напусти твој рачунар. Који облик прекривања да изабереш зависи од тога шта мора остати читљиво. После дељења се замагљење не може поништити.

Додај метаподатке који помажу

Страница за дељење која приказује димензије, величину датотеке и датум снимања уштеди једну рунду питања „на којој резолуцији си радио?“. Странице за дељење у Shotivo-у приказују ширину × висину, величину датотеке, датум настанка и датум истека, па се лепљењем линка тај контекст преноси аутоматски.

У самом тексту пријаве додај:

  • Назив апликације и верзију (нпр. „Shotivo 1.x“ или број верзије производа на који се грешка односи)
  • Оперативни систем и верзију („macOS 15.2“)
  • Једноредну напомену о окружењу ако је битна („екстерни 4K монитор“, „VPN укључен“)

Ток рада: три секунде до снимка који можеш да поделиш

Са алатом за снимање из траке менија (приказане су Shotivo подразумеване пречице):

  1. ⌘⇧9: превуци преко покварене регије. Уређивач се отвара одмах.
  2. Кликни на алат Стрелица и означи елемент, замагли све осетљиво и исеци кадар уско.
  3. ⌘↩ (Подели): отпрема слику и копира линк shotivo.app/s/… у клипборд.
  4. Налепи линк у тикет, а испод њега кораке за репродукцију.

Од првог притиска на тастер до линка спремног за лепљење потребно је отприлике три до пет секунди. Free линкови истичу после 7 дана, а Pro линкови могу остати активни до 90 дана (подразумевано 90 дана). Ако је тикету потребна трајна локална копија, преузми оригинал. Ако ниси сигуран који лимит важи за тебе, погледај како се рок чувања разликује по плановима.

Шаблон

[Апликација] [Компонента] · [резиме у једном реду]

Кораци:
1. …
2. …
3. Примети: <шта се дешава>

Очекивано: <шта би требало да се деси>

Снимак: <налепи линк за дељење>
Окружење: macOS 15.2 · верзија апликације 1.x · <напомена о екрану ако је битна>

Попуни шаблон за мање од минута и добићеш пријаву по којој програмер може да ради без додатног позива. Снимак показује, а та три реда објашњавају.

Честе грешке

  • „Погледај прилог.“ без корака за репродукцију. Програмер мора да погађа како да дође до тог стања.
  • Снимак целог екрана за мали проблем. Стрелица показује на 2% кадра.
  • Незамагљене тајне. Пријава се прослеђује, архивира и индексира, а твој токен је од тада јаван.
  • Пет снимака истог стања. Један добар снимак и пар речи вреде више од пет просечних.
  • Снимак направљен пошто си грешку „поправио“. Прво сними покварено стање, а касније увек можеш поново да снимиш.

Мерило је ниско, а вреди га достићи: може ли програмер који никад није видео ову апликацију, само на основу твог текста, да дође до поквареног стања, а са твоје слике да види шта је тачно погрешно? Ако може, пријава је готова.