10 добри маниери при описание на грешки
Здравейте, казвам се Наталия, аз съм QA инженер в Docsvision. Понякога, когато гледам грешки, написани от нови (а понякога и стари) тестери, ръката ми автоматично се протяга към лицето ми. Има само една мисъл в главата ми:
"Какво? Какво прочетох току-що?
„В контролата на файла, ако има достатъчно файлове, имената на някои не се показват изцяло. Създайте произволен UD документ. В раздела Регистрация, в полето Добавяне на файл щракнете с десния бутон на мишката и изберете няколко файла. Втората опция е да плъзнете и пуснете няколко файла в даденото поле. В резултат на това, ако има няколко файла, имената не пасват напълно. Само ако разширите картата на цял екран, можете да видите всичко в пълен размер. Редът на файла трябва да премине към следващия ред в контролата, но не го прави."(Правописът и пунктуацията са запазени).
Някакъв невероятен текст, състоящ се от непрекъснат поток от съзнание. Колеги! Пишеш за други хора, които имат съвсем друга глава и съвсем различен начин на мислене. Трябва да пишете ясно!
Ето и ТОП 10 правила за добри обноски, към които аз самият се придържам и които препоръчвам на колегите: 1) Първо глаголът. 2) Принципът какво-къде-кога. 3) Анонимност. 4) Прости дизайни. 5) Без повече приказки. 6) Намалете очевидното. 7) Опростете описанието на сложно действие. 8) Точка по точка. 9) Уникалност. 10) Прочетете отново.
Учителят Йода от Междузвездни войни говореше по такъв начин, че не беше лесно да го разберем от първия път. Речта му е изградена на принципа "обект-глагол-субект". "Когато станете на 900 години, вие също няма да изглеждате млади." В нашата реч глаголът е в началото (ако има такъв).
Пример: Лошо – „Отворете копираната карта за редактиране“. Добре – „Отворете копираната карта за редактиране.“
2. Принципът "Какво-Къде-Кога"
Този принцип е добре известен - първо трябва да напишете „какво“, а едва след това „на какво място“ и „при какви условия“. Работи най-добре, когато съставяте кратко описание на грешката. Какво става? – „Картата не е създадена“, „Изхвърлено е необработено изключение“, „Базата данни не е създадена“. Къде се провежда? – „Във виртуалната папка“, „В раздела История“, „В контекстното меню“. Кога се случва? – „При натискане на бутон“, „След промяна на състоянието на картата“, „При запазване на промените“.
3. Безличен
Описанието на грешката не е хроника на вашите действия, а ръководство за друг човек. Премахнете себе си от описанието.
Пример:Лошо - „Натисни бутон“, „Отвори страница“. Добре - "Натисни бутон", "Отвори страница".
4. Прости дизайни
Сложните и сложни изречения, причастните и наречните фрази усложняват възприемането на текста. Колкото по-просто е изречението, толкова по-добре.
Пример:Лошо – „Има бутон на лентата с инструменти със зъбно колело, който отваря меню от два елемента, което не показва подсказка, когато се задържи върху него.“ Добре – „Задръжте курсора на мишката върху бутона със зъбно колело на лентата с инструменти – не се появи подсказка.“
5. Без повече приказки
Когато гледам съветски филми, в които всяка втора фраза е станала закачлива, се възхищавам колко внимателно е отработена речта на героите. Нито една допълнителна дума. Всяка дума си струва злато. Трябва също така да напишете описание на грешките - всяка думатрябва да означава нещо. Обичайната реч е богата на епитети, местоимения, предлози, които не добавят допълнително значение. Ако е много трудно да се справите със собствения си мозък, запишете целия поток на съзнанието такъв, какъвто е, и след това премахнете от текста онези думи, които не носят семантичен товар.
Пример:Лошо – „По някаква причина промяната на стойностите в полето работи доста странно – всъщност полето се актуализира след известен период от време.“ Те не съдържат ценна информация и могат да бъдат премахнати от описанието, без да загубят смисъла си. Фразата "известен период от време" може да бъде заменена с по-кратък синоним.Добре – „Има забавяне при актуализирането на стойностите в полето.“
6. Намалете очевидното
Някои действия не са специфични за тестваната система. Например, запазване на някакъв обект, затваряне на прозореца, извикване на контекстното меню, двойно щракване, стартиране на приложението. Тези стъпки обикновено са интуитивни, така че не ги наблягайте прекалено, когато описвате грешка.
Пример:Лошо - „Намерете прекия път на приложението на работния плот, щракнете върху него 2 пъти с левия бутон на мишката.“ Добре - „Отваряне на приложение чрез пряк път“.
7. Опростете описанието на сложно действие
Да предположим, че има някаква специфична операция в тестваната система. Новите тестери или разработчиците, които са слабо запознати с интерфейса, може да не знаят как да извършат такава операция. Следователно можете да опишете изпълнението на тази задача чрез описанието на прости действия, които ще ви помогнат да я изпълните.
Пример:Лошо - „Съгласен документ“, „Извършване на синхронизиране на свойства“. Добре -„Натиснете бутона „Съгласено“ в лентата с инструменти на картата с документи“, „Изберете командата „Синхронизиране на свойствата“ в контекстното меню на обекта.“
Важно!Това, което е очевидно за вас, не винаги е очевидно за друг човек. Лично аз използвам 2 метода за оценка на очевидността на моето описание: 1) Представете си, че виждате интерфейса за първи път; 2) Предвидете въпросите, които читателят може да има.
8. По точки
Добра практика е да разделите стъпките на възпроизвеждане на абзаци. Това има 2 основни предимства: 1) Улеснява преминаването през стъпките на възпроизвеждане. 2) Става възможно да се препраща към някакъв артикул.
Или1) Създайте карта с документи. 2) Създайте карта с документи от друг тип. 3) Отворете картата, създадена в стъпка 1.
Колко действия трябва да съдържа един елемент? Въпрос, на който всички тестери отговарят по различен начин. Мисля, че общият брой точки трябва да бъде не повече от 5-6, следващите точки вече се възприемат по-трудно, първото предимство се губи. Един елемент трябва да съдържа набор от действия, които ви позволяват да достигнете определена точка. Такава точка може да бъде появата на системно съобщение, създаването на някакъв артефакт в системата - всичко, на което можете да поставите възпроизвеждането на пауза.
9. Уникалност
Речта ни е богата на синонимни думи и изрази, някои от тях са подходящи и разбираеми за всеки, други не толкова. Придържам се към следните три принципа.Първият принципе да се избягват жаргони и неясни думи.
Пример:Лошо - „системата псува“, „щракване в млякото“, „прозорецът излиза зад екрана“, „отказ“. Добре - "изхвърлено е необработено изключение", "щракване в празна област на прозореца", "прозорецсе премества извън екрана", "отказ".
Второ- използвайте думите, приети във вашата команда. Вторият принцип понякога може да изключи първия. Например, ако всички в компанията казват „инвалидиран“ вместо „неактивен“, тогава използването на тази дума ще бъде по-разбираемо за останалите членове на екипа. Никой не отива в магазина за галваничен елемент, всички отиват за батерии.
Важно!Ако различните колеги говорят по различен начин (някои „намек“, други „намек“), по-добре е да използвате и двете думи, когато описвате такава грешка, за да сте по-ефективни.
Трето- Едно от правилата, прокламирани във филма Посветеният е "Използвайте думите правилно." Например, понякога думата "знак" се заменя с думата "буква", но това са различни входни данни, те не трябва да се бъркат.
10. Препрочетете
След като сте написали и коригирали описанието на грешката, не забравяйте да го прочетете отново от началото до края. Може би ще намерите печатна грешка, случайно повторение на дума, допълнителен знак или нещо подобно. Тъй като очите ми се замъгляват от четене на собствения ми текст, използвам метода за превключване на вниманието - отмествам поглед само за няколко секунди към растение в саксия или съсед отляво и след това се връщам към текста.
Освен това ви съветвам да прочетете книгатаLee Lefever„Изкуството да обясняваш. Как да сте сигурни, че сте разбрани перфектно.
PS: Убиецът е иконом, а онзи "невероятен текст" от началото на статията трябваше да изглежда така:
„Имената на файловете не се поставят напълно във файловата контрола на документа, ако има няколко файла. 1) Създайте всеки UD документ. Оставете в режим на прозорец, не преминавайте на цял екран. 2) Добавете повече от 1 файл в раздела Регистрация вконтрол на файла (с помощта на командата от контекстното меню или плъзгане и пускане).
Резултат: Имената на файловете не се виждат напълно. Няма достатъчно място за показване на имената на файловете при размера на прозореца по подразбиране. Очакван резултат: Имената на файловете трябва да се показват изцяло."