Ляпы в документах

Сижу и вычитываю документацию по проекту, медленно сползаю под стол. То, что мне встречается по тексту и как не нужно писать, привожу ниже.

1. Глоссарий и перечень сокращений и аббревиатур – это важно и хорошо. Но первое упоминание в тексте должно быть полным. Не нужно при первом удобном случае писать «ТЗ», напишите сначала «Техническое задание (далее – ТЗ)».
2. Какие бы сокращения и короткие названия вы ни использовали (Система, Заказчик, Исполнитель, прочие), пишите их однообразно по всем документам проекта: либо все со строчной, либо все с прописной буквы.
3. Падежи! ru.wikipedia.org/wiki/Падежи
4. Если вы используете наименования стороннего программного обеспечения (далее – ПО) в разных частях документа (требования к квалификации персонала, требования к ПО, требования к АРМ-ам, пр.), то формулировки и версии этого ПО должны быть идентичными: «MS Internet Explorer версии 8.0 и выше» везде, и никакого «Microsoft IE 8.5″ и тому подобного.
5. Для англоязычных стандартных элементов интерфейса есть переводы на русский язык. «Прогрессбар» – это слово-уродец, которое, я искренне надеюсь, не приживётся в нашем и без него уже гаджето-девайсном языке.
6. Тире ≠ дефис! Тире ставится между словами! Это такая большая чёрточка, длинная. О том, когда ставится тире, читайте на Грамоте.ру. Чтобы заменить во всём документе коротенькие чёрточки на нужные, нажмите Ctrl+H и введите в поле «Заменить» [пробел][дефис][пробел], а в поле «Заменить на» [пробел][тире][пробел]. К счастью, если писать документ последовательно, то в большинстве случаев Word наменяет знаки дефисов на знаки тире.
7. Дефис ≠ тире. Вокруг дефиса нет пробелов.
8. Русский язык богат синонимами, но техническая документация– не место для демонстрации его разнообразия. Формулируйте требования однообразно: «Система должна обеспечивать [нечто]«. Если используете слово «должно», то забудьте слова «нужно» и «необходимо».
9. Стройте предложения в активном залоге. «Система должна отображать окно ввода данных» вместо «Должно отображатьСЯ окно ввода данных».
10. Единый перечень стилей по всему комплекту документов. Если Вы маркируете список уровня 1 чёрточками, то не маркируйте его точками.
11. Пунктуация при оформлении списков – см. тут.
12. Зачем точка после «кг»? Если забыли школьную физику, то идём сюда к разделу «Правила написания обозначений единиц«.
13. Чтобы ≠ что бы! «Чтобы» – союз или частица, а «что бы» – это местоимение «что» с частицей «бы». Чтобы = дабы, для, с намерением, с целью. Например: «Система должна обеспечивать [нечто], чтобы [выполнялось что-то ещё]«. Очень сомневаюсь, что в ТЗ может потребоваться несущая неопределённость формулировка вроде «Что бы такое выполнить». Усиления вроде «Что бы ни произошло, система должна [выполнять нечто]» лучше заменять на «Система должна [выполнять нечто] при наступлении [конкретных событий]«.
14. Также ≠ так же. Обращаемся к словарям:
    

    также, нареч. и союз (он также согласен), но нареч. с частицей так же (он так же думает, как ты)
    также присоединяет однородные члены предложения или предложения в составе сложного. Он был хорошим другом, учился также хорошо. Брат бросил курить, вам также следует сделать это. Он согласен, мы также не возражаем.

15. Если причастный оборот стоит после определяемого слова, то он выделяется запятыми.
16. Деепричастный оборот всегда выделяется запятыми.
17. Не употребляйте кванторы общности: «все», «каждый», «никто», «всегда», «никогда», «везде», «нигде» и подобные им слова. Очень вероятно, что такое требование либо невыполнимо, либо может трактоваться разными способами.
18. Не завершайте перечисления и списки такими слова, как «и т.д.», «и прочие», «и другие». Какие такие «другие»? Зафиксируйте конкретный перечень. Если считаете, что список может и должен быть дополнен, то добавьте примечание «Перечень [того-то] может/должен быть дополнен/уточнён на этапе технического проектирования».
19. Избегайте причастий, не уточняющих требование. Например: «Данные должны передаваться в согласованном формате». Что это за «согласованный формат»? Когда и кем он согласован? Лучше написать: «Данные должны передаваться в формате, описанном в пункте N настоящего технического задания» или другом месте. Если этот формат ещё до конца не известен, то добавьте фразу «Формат передачи данных должен быть уточнён и согласован сторонами на этапе [ваш этап]«.
20. Без особой необходимости не используйте разные шрифты в документе. Понятно, что куски программного кода нагляднее оформляются шрифтом Courier New, однако проверяйте, что однотипные блоки текста оформлены в едином стиле, и схожие абзацы или ячейки таблицы не оформлены и Times New Roman, и Arial.

Дополнительные спорные формулировки «на вкус и цвет»:

1. «Кликнуть мышью по иконке». Один мой коллега и перспективный аналитик верно подметил, что кличут в лесу, когда потерялись, а иконки – в церкви. Лично я сторонник версий «выбрать пиктограмму» и «щёлкнуть кнопкой мыши». Однако Грамота.ру говорит нам, что в русском языке прижилось слово «click’ать». К радости, пока только в разговорном языке. Lingvo же переводит click следующим образом:
   

   информ. щёлкать, кликать (нажимать и отпускать кнопку мыши)

   • to click on an icon — выбрать пиктограмму, щёлкнуть на иконке
   • to click a mouse button — кликнуть кнопкой мыши

Каких ещё банальных ошибок можно с легкостью избежать, чтобы результирующий документ стал качественным?

Комментарии (отредактировать)

1. Еще было бы неплохо:
   1. Определяться с глоссарием на начальном этапе и доводить этот глоссарий до всех участников команды разработки, которые будут писать те или иные документы.
   2. Давать ссылки на все таблицы, иллюстрации и приложения, которые есть в документе. Они должны быть привязаны к конкретным местам документа.

   Помимо наличия ссылок на таблицы и иллюстрации, эти таблицы и иллюстрации должны быть, как минимум, названы, и, желательно, однотипно.

   И то, что, возможно, и не так критично, но может выглядеть неопрятно:
   – общее форматирование текста: абзацы, отступы, выравнивание (единые для всего документа);
   – лишние пробелы между словами, лишние переходы на новую строку между абзацами (форматирование текста лучше реализовать с помощью стандартных средств редактора)

   Обычно делаю Ctrl+H и заменяю по всему тексту 2 пробела на 1 пробел, 2 перехода на новую строку на 1, сочетание «пробел^p» на просто ^p (переход на новую строку).

2. У Влада Головач в его знаменитой книге также приведены рекомендации о том, как правильно именовать элементы пользовательского интерфейса. Их я всегда использую в своей практике.
   Писал даже как-то отзыв на эту книгу: http://it-analysis.blogspot.com/2010/12/2.html
   А за статью спасибо. Она очень поучительна.

3. Дополнение, которое трудно отразить с помощью редактора.
   Кавычки под кнопками 2 и Ж – разные. Если дописываете или изменяете не свой документ, то воспользуйтесь автоматической заменой по всему тексту Ctrl+H одних кавычек на другие.

   Дополнения (источник – Грамота.ру):
   2. После сокращения «тыс.» ставится точка, после сокращений «млн» и «млрд» – нет точки.
   3. Знак номера № от самого номера (цифры) нужно отделять пробелом, а в вёрстке используется короткий пробел, т. н. «полукегельная».
   4. Между цифрами ставится тире без пробелов: 2–3, 20–30. Между датами ставится тире без пробелов: временной интервал должен выглядеть 1999–2001 гг. (НЕ тире с пробелами).