17 вредных советов для тех, кто проверяет документацию и технические тексты
Вы пишете документацию, статьи или другие тексты? Тогда, наверняка, у вас есть проверяющие. Я уверен, что вы нежно и трепетно любите своих проверяющих. Вы, скорее всего, с нетерпением ждёте, когда они пришлют вам свои правки и комментарии. Благоговейно изучаете и перечитываете крупицы мудрости, которыми проверяющие благосклонно поделились с вами. Лучшие из комментариев вы записываете в специальную тетрадочку или даже распечатываете и вешаете их на стену… Кстати, если серьёзно, то я иногда так и делаю. Положим, до распечатывания цитат я ещё не дошёл, но вот специальная «тетрадочка» у меня уже есть. Точнее, текстовый файл.
Часто мне самому приходится выступать в роли «сурового проверяющего» и вычитывать документацию и тексты, которые пишут технические писатели. При этом я вижу и анализирую комментарии, которые оставили к этим текстам другие проверяющие. Я начал коллекционировать самые фееричные комментарии. Делаю я это для того, чтобы иметь перед глазами антипример — как ни в коем случае нельзя писать комментарии к чужим текстам.
Мои вредные советы — своеобразная квинтэссенция этих записей — тщательно отобранные, систематизированные и дистиллированные советы для проверяющих. Практическое руководство по доведению до белого каления ваших технических писателей и авторов.
Дисклеймер. Все совпадения фрагментов этого текста с реальными комментариями в вашей документации совершенно случайны. При написании этого текста не пострадал ни один проверяющий.
1. Пишите комментарии как можно более эмоционально и расплывчато:»Да неужели?! »,»Вот это да! »,»Жесть». Это оживит процесс общения.
2. В общих комментариях обязательно напишите:»Весь документ надо переписать заново!». Даже если в замечаниях к тексту на несколько сотен страниц вы исправили только пару незначительных ошибок. Это будет держать писателя в тонусе.
3. Вместо того, чтобы объяснить, как исправить ошибку, задайте техническому писателю вопрос:»Разве это так работает? ».
4. Ещё лучше напишите комментарий, состоящий из одного знака вопроса. Или просто напишите:»Это не так». Писателю будет интересно догадаться, как же всё устроено на самом деле.
5. Если вы не профессиональный редактор или корректор, то старайтесь как можно чаще исправлять стилистику текста. Давайте писателю советы о том, как лучше составлять предложения.
6. Пишите комментарии вроде »Это надо обязательно проверить». Писатель любит развлечься тестированием системы.
7. После того, как писатель наконец протестировал систему и удостоверился, что всё было указано правильно, напишите, что этот комментарий вы написали »Для себя».
8. Присылайте комментарии за полчаса до срока отгрузки документа заказчику. Писателю будет полезно потренировать важный навык стрессоустойчивости.
9. Никогда не берите на себя ответственность за правильность предоставленной информации. В каждом комментарии используйте слова:»кажется»,»наверное»,»вроде». Документ пишет писатель, он и будет отвечать.
10. Никогда не сообщайте писателю о важных изменениях в логике работы системы, внесённых в ходе разработки. Технический писатель должен самостоятельно просматривать сотни заявок и выискивать те, что относятся к теме документа. Если не нашёл — сам виноват. Сообщите ему об этом при проверке документа:»Это уже давно не так! ».
11. Ещё лучше вообще не заводить заявку. Технический писатель должен сам догадаться, что кнопка теперь работает по-другому. Интуиция — его профессиональное качество. Вообще, лучше поменьше письменно фиксировать информацию о работе системы. Писать — это дело писателя.
12. Настаивайте на том, чтобы писатель использовал жаргонные термины в тексте:»Так все говорят, заказчику будет понятнее».
13. Чем больше людей проверяет документ, тем лучше. Писателю будет интересно решить логическую задачу по совмещению противоположных друг другу исправлений.
14. Не вносите комментарии прямо в проверяемый документ. Каждое замечание к тексту лучше присылать отдельным сообщением в мессенджере. Нашли ошибку — сразу отправляйте её писателю. Ему будет интересно отвлечься от другого документа, над которым он сейчас работает.
15. Почаще вставляйте комментарий:»Это надо переписать! ». Писатель — профессионал своего дела. Ему будет очевидно, что именно не понравилось проверяющему в выделенном фрагменте текста.
16. Никогда не проверяйте документ до конца. При повторной вычитке находите ошибки в уже проверенных частях. Чем больше итераций проверки, тем интереснее и замысловатее.
17. После нескольких итераций исправлений одного и того же места в тексте вернитесь к первоначальному варианту. Напишите, что »Так стало гораздо лучше».
Ещё почитать:
