Images & photos · Браузер Image & Drawing Editor
Як анотувати звіт про помилки скріншот, тому розробники діють на нього
· Чому це питання
Опубліковано ToolAcre · Редакція журналу
зображення полотно веб-переглядач
Знімок екрана з прозорою коробкою, одна стрілка і коротка заказка зберігає круглі питання; знімок екрана запрошує їх. Цей пост встановлює невелику конвенцію анотації та показує, як застосувати його в редакторі браузера.
Знімок екрана, який генерував три питання з'ясування — чому «дивитись прикріплений» не є звітом про помилки
Корисна помилка скріншот відповідь на перше питання перед читачем, щоб запитати його. Захоплення ярликів 'див. прикріплений' залишає розробнику пошук дефекту, уражений контроль і очікуваний результат. Невелика візуальна лексика редактора досить зменшити, що неоднозначність: урожай до відповідної області, привернути прямокутник навколо проблеми, використовувати лінію для безпосередньої уваги, а також додати лаконічну підписку.
Поставити зображення як докази, а не весь звіт. Текст стає пікселям відразу, тому напишіть підписку перед експортом і зберігайте його досить коротким, щоб сканування. Відтворення кроків, журналів і очікуваної поведінки все ще належить до образу, оскільки не можна описувати взаємодії або стан, який захоплений кадр не показує.
Одна проблема з зображенням — обрізка до відповідного регіону, тому дефект є першим, що читач бачить
Одна проблема на зображення дає читачеві чітку візуальну ціль. Висаджувати не пов'язані панелі, браузер хрому і сусідні контрольи, якщо вони встановлюють необхідний контекст. Затяжна культура робить дефект першим, що бачив, в той час як трохи ширша рама може зберегти зв'язки між зламаним управлінням і навколишнім макетом.
Порівняйте урожай з оригінальним перед експортуванням, так що звіт не випадково знімається, що потрібно відтворити проблему. Знімок екрана слід доповнювати, а не замінювати дії, журнали та очікувану поведінку.
Шпильки з значенням: коробка, стрілка, підписка — мінімальна конвенція для чого говорить кожен знак і коли використовувати кожну
Кожна марка повинна виконувати одну роботу. прямокутник ізолює уражений контроль або регіон, лінія направляє око до розриву або знезараження, а захоплення пояснюється передбачуваною різницею. Цей редактор пропонує прямокутник, рядок та текстові позначки; він не має значення стріли, тому описувати напрямок в приписі, коли звичайний рядок може бути прочитаний неоднозначно.
Зберігати конвенцію стабільною по всій команді, тому читач не повинен декодувати декоративні варіанти. Текст передається у зображення при розміщенні і не може бути переоцінений як окремий об'єкт, що робить слово і розташування, варто перевірити до експорту. Зображення залишається підтриманим доказом, не заміною для поведінкових деталей звіту.
Шпильки з значенням: прямокутник, лінія і заклеювання; цей редактор не має інструменту стріли
Колір і вага - вибір зв'язку, не прикраса. Тонкий червоний інсульт може зникнути на темний інтерфейс або стати важко читати після зменшення зображення. Підберіть колір з чітким контрастом, дайте прямокутник достатню ширину, щоб вижити експорт, а не розміщувати рядок безпосередньо над деталями UI, щоб визначитися.
Перевірити готовий образ за розмірами розробника буде фактично переглядати в трекері видачі. Контраст повинен вижити як світлі, так і темні регіони, а при заборі слід залишатися читаним без покриття дефекту. Підтримуваний звіт все ще потребує кроків відтворення і журналів; візуальний акцент може вказувати на докази, але не може поставлятися відсутню поведінку.
Очікуваний versus фактичний — додаючи коротку заказку, що говорить про те, що повинно відбуватися, у самому образі
Очікується, що виснажливе слово перетворюється на невеликий позов. “Вибрано: кнопка вирівнюється з входом; фактична: кнопка сидить 12 px невисока» дає читачеві більше напряму, ніж кольорова коробка. Зберігати, що захоплення фактичного і компактного, оскільки експортоване зображення необхідно уточнити видиму невідповідність, а не стати пунктом спекулятивної діагностики.
Помістіть текст біля позначеної області без покриття контролю або зазору. Редактор опрацьовує текст при розміщенні, тому перевиправте слово та позицію перед експортом замість того, щоб змінити текст пізніше. З одного статичного каркасу слід виконувати деталі, які не можуть бути встановлені.
Виготовлений приклад: неправильна кнопка — обрізка, коробка елемента, стрілка до зазору, захоплення очікуваним положенням
Візьміть неправильну кнопку як приклад роботи. Вирізати щільно, щоб показати кнопку і його сусідні посилання вирівнювання, намалювати прямокутник навколо управління, і використовувати рядок, щоб вказувати на видимий проміжок. Тому що редактор не має інструмент стріли, нехай рядок виявить місце розташування і нехай не потрібно вказувати стан, де кнопка повинна сидіти.
Захоплення, такі як “Вибрано: вирівняно з полем; фактичне: зміщене вниз” робить візуальне порівняння чітким без претендування діагностувати причину. Інспектування контрастності інсульту та розміщення тексту, після чого експортується позначений растровий пристрій. Додайте шлях відтворення, деталі браузера та журнали у квитку, так що скріншот залишається однією сильною частиною доказів, а не весь звіт.
Виготовлений приклад: неправильна кнопка, позначена коробкою, натискна лінія і приклеювання
Знімок екрана не може показувати послідовність клацань, часовий забіг, виключення консолі, відповідь мережі або стан, який з'являється тільки після перезавантаження. Не замінює запис екрану при порушенні рухів, і не може стоятися за дії відтворення або журнали. Знімок повинен звужувати розслідування, не схильний до наявності цілого інциденту.
Зберігати ці межі, видимі у квитку. Включаючи навколишнє середовище, очікуваний результат, фактичний результат, етапи та відповідну діагностику при культурі. Ректкутник, лінія та текстові позначки роблять візуальний дефект легше знайти, а решта звіту пояснює, як це зробити знову і що скріншот не може встановити.
Takeaway: кілька знаків, чіткий звіт — як зображення браузера та креслення головного редактора, анотація та інструменти малювання виробляють скріншот, який не потребує спостереження
Відзначається, як правило, робить звіт більш чітким. Вирізати дефект, відобразити один прямокутник, використовувати рядок, де має напрямок, і додати коротке заказання, яке іменує очікувану різницю. Редактор зображень і малювання браузера постачає ті культури, лінії, форми та текстові можливості, як редагування растрових, без претендування на ґрунтову примітивну або повну систему збоїв.
Експортувати лише після перевірки контрасту, розміщення та замовлення на вимогу глядача. Потім попарюйте зображення з кроками відтворення, журналами та деталями середовища. Впроваджені інструменти можуть зробити важливі пікселів очевидними; вони не можуть видалити необхідність у поведінкових доказах, які дозволяють розробникам відтворювати і виправити дефект.