Comments 7
Введение с явным обозначением проблематики, которую должен решать данный материал, с обозначением состояния на начальном этапе и обозначением ожидаемого состояния на момент исполнения читателем действий описанных в материале. В случае с тикетом это — обязательное описание ожидаемого поведения программного обеспечения и фактического. По возможности должна быть отсылка на источник с описанием корректного поведения.
Ох. Мой мозг на автомате начинает скипать такие тексты. Может, конечно, это я такой тупой, но это же всё-таки инструкция.
Напишите в вашем тикете/багрепорте:
0. Заголовок — краткое описание проблемы.
1. Окружение, на котором она происходит (продукт, локально/транк/тест/прод, учётка).
2. Начальное состояние продукта (залогинился/запустил программу, программа работала 3 часа простаивая).
3. Что было сделано, конкретно, по шагам (нажал эту кнопку, вбил в это поле «12345»).
4. Что получили в итоге (неправильный ответ «123», ошибка «неверный дескриптор 1234», зависание).
5. Что хотели получить (правильный ответ «333», отсутствие ошибки, отсутствие зависания).
6. Ссылки на ТЗ/согласования, почему хотели бы получить именно это (если не очевидно).
7. Скриншоты, логи, дампы, исходные файлы, полученные файлы и т.п., если есть.
Вот я присоединюсь: ваш текст для меня как раз хуже, чем чеклист. Потому что а) по объему гораздо больше чеклиста б) ценности дополнительной этот объем не несет
Ценностью может быть не только информация — это может быть развлечение, эмоциональное вовлечение, или своеобразная эмоциональная поддержка читателю. Но в вашем тексте этого нет.
Я согласен, что полезно уметь писать текст без воды. Это полезная практика: регулярно спрашивать себя, что пострадает если я вычеркну из предложения вот это слово?
Но многие люди путают текст без воды с текстом с замаскированной водой. Например, безличные обороты часто увеличивают объем, не увеличивая смысла: "Я нажал кнопку ОК"/"Необходимо произвести нажатие кнопки ОК". Безличные обороты сложнее воспринимаются: там глагола либо вообще нет, либо он стоит где-то далеко от существительного, и мозгу труднее связать все части воедино, чтобы воссоздать картинку.
Есть еще стилистический аспект: безличные обороты тесно связаны с канцеляритом. Тексты с безличными оборотами — это чаще всего бюрократические/юридические документы. И когда человек начинает писать безличными оборотами — он часто сваливается в канцелярит, ведь это самый распространенный шаблон такого рода текстов. А это ужасно читается.
Поэтому — нет, не надо использовать безличные обороты. Вместо этого надо научиться ясно использовать "личные" обороты. Не надо писать от имени непонятного третьего лица — пишите от своего имени, но пишите ясно. Это тоже навык, но мне кажется — это более полезный навык, чем навык писать от имени "того парня"
Спасибо. Теперь я знаю какой костюм у капитана очевидность
Если захотелось написать коллегам о том как что-то сделать