Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

24 Typical Mistakes In Documents

4,275 views

Published on

24 ляпа в документах, которые лучше не делать
http://beamteam.ru/2011/09/mistakes-in-documents/

Published in: Education

24 Typical Mistakes In Documents

  1. 1. которые лучше не делать ляпа
  2. 2. Двусмысленные термины и сокращения Создавайте глоссарий как можно раньше. Систематически проверяйте и актуализируйте его. Доводите глоссарий до всех участников команды.
  3. 3. Первое упоминание в тексте должно быть полным. Глоссарий – это важно и хорошо. Перечень сокращений и аббревиатур – это важно и хорошо. Но первое упоминание в тексте должно быть полным. Не нужно при первом удобном случае писать «ТЗ», напишите сначала «Техническое задание (далее – ТЗ)».
  4. 4. Падежи Соблюдайте падежи. Правила склонения: ru.wikipedia.org/wiki/Падежи
  5. 5. Формулировки и версии продуктов должны быть идентичными Если вы используете наименования стороннего программного обеспечения (далее – ПО) в разных частях документа: • требования к квалификации персонала, • требования к ПО, • требования к АРМ’ам, • других, то формулировки и версии этого ПО должны быть идентичными: • «MS Internet Explorer версии 8.0 и выше» везде, • и никакого «Microsoft IE 8.5» и тому подобного.
  6. 6. Переводы на русский язык должны быть общепризнанными. Для англоязычных стандартных элементов интерфейса есть переводы на русский язык. «Прогрессбар» – слово-уродец. Давайте не дадим ему попасть в наш могучий и без него уже гаджето-девайсный язык. • Правильно: раскрывающийся список, флажок, значок/пиктограмма, вкладка. • Неправильно: выпадающий список, чек-бокс, иконка, закладка, юзер.
  7. 7. На вкус и цвет Кликнуть мышью по иконке – «Кличут в лесу, когда потерялись, а иконки – в церкви» – «Стал он кликать золотую рыбку» Варианты: • выбрать пиктограмму | щёлкнуть кнопкой мыши Однако: • Грамота.ру говорит, что в русском языке прижилось слово «click’ать». К радости, пока только в разговорном языке. • Lingvo переводит click : информ. щёлкать, кликать (нажимать и отпускать кнопку мыши) – to click on an icon — выбрать пиктограмму, щёлкнуть на иконке – to click a mouse button — кликнуть кнопкой мыши
  8. 8. Тире ≠ дефис Тире ставится между словами! Тире – это такая большая чёрточка, длинная. О том, когда ставится тире, читайте на Грамоте.ру. Если писать документ последовательно, то в большинстве случаев Word заменяет знаки дефисов на знаки тире. • Между числами ставится тире без пробелов: – 2–3, 20–30. • Между датами ставится тире без пробелов: – временной интервал должен выглядеть 1999–2001 гг. (НЕ тире с пробелами).
  9. 9. Дефис ≠ тире Вокруг дефиса нет пробелов. Дефис ≠ тире! Вокруг дефиса нет пробелов.
  10. 10. Синонимы и омонимы Устраняйте их! Техническая документация – не место для демонстрации богатства русского языка. Формулируйте требования однообразно: • «Система должна обеспечивать [нечто]». • Если используете слово «должно», то забудьте слова «нужно» и «необходимо».
  11. 11. Активный залог Пассивный залог Стройте предложения в активном залоге: • «Система должна отображать окно ввода данных» • вместо «Должно отображаться окно ввода данных».
  12. 12. Пользуйтесь едиными стилями оформления всего комплекта документов. Единый перечень стилей по всему комплекту документов. • Если Вы маркируете список уровня 1 чёрточками, то не маркируйте его точками. • Единообразно форматируйте текст: – абзацы, отступы, выравнивание – наименования таблиц, рисунков, заголовков
  13. 13. Пунктуация списков Только 2 способа. Независимо от вида маркеров текст может оформляться только 2 способами: • Вводное предложение: – элемент; – элемент; – элемент. • Вводное предложение: – Элемент. – Элемент. – Элемент.
  14. 14. Сокращайте килограммы правильно кг млн млрд – без точек! Зачем точка после «кг»? Если забыли школьную физику, то сморите «Правила написания обозначений единиц». После сокращения «тыс.» ставится точка, после сокращений «млн» и «млрд» – нет точки!
  15. 15. Чтобы ≠ что бы «чтобы» – союз или частица «что бы» – это местоимение «что» + частица «бы». • Чтобы = дабы, для, с намерением, с целью. – «Система должна обеспечивать [нечто], чтобы [выполнялось что-то ещё]». – Вряд ли в ТЗ может потребоваться несущая неопределённость формулировка вроде «Что бы такое выполнить». – Усиления вроде «Что бы ни произошло, система должна [выполнять нечто]» лучше заменять на «Система должна [выполнять нечто] при наступлении [конкретных событий]».
  16. 16. Также ≠ так же Тоже ≠ то же Из словаря: • Также – наречие и союз – «Он также согласен» – присоединяет однородные члены предложения или предложения в составе сложного – «Он был хорошим другом, учился также хорошо» – «Брат бросил курить, Вам также следует сделать это» – «Он согласен, мы также не возражаем» • Так же – наречие с частицей – «Он так же думает, как и ты»
  17. 17. Причастный оборот выделяйте запятыми, если он расположен после определяемого слова.
  18. 18. Деепричастный оборот выделяйте запятыми всегда! И до определяемого слова, и после него.
  19. 19. Кванторы общности не употребляйте. • Все, каждый, никто • Всегда, никогда • Везде, нигде • и подобные им слова. Очень вероятно, что такое требование либо невыполнимо, либо может трактоваться разными способами.
  20. 20. Какие такие «другие»? Что такое «и т. д.»? НЕ завершайте перечисления и списки оборотами: – и т.д. – и прочие – и другие Зафиксируйте конкретный перечень. Если считаете, что список может и должен быть дополнен, то добавьте примечание «Перечень [того-то] может/должен быть дополнен/уточнён на этапе технического проектирования».
  21. 21. Что за «согласованный формат»? Избегайте причастий, не уточняющих требование. «Данные должны передаваться в согласованном формате» • Что это за «согласованный формат»? • Когда и кем он согласован? Лучше написать: • «Данные должны передаваться в формате, описанном в пункте N настоящего технического задания» или другом месте. – Если этот формат ещё до конца не известен, то добавьте фразу «Формат передачи данных должен быть уточнён и согласован сторонами на этапе [ваш этап] до [ваш срок]».
  22. 22. Используйте 1-2 шрифта Не используйте несколько шрифтов без особой необходимости. Куски программного кода нагляднее оформляются шрифтом Courier New. Однако проверяйте, что однотипные блоки текста оформлены в едином стиле, а схожие абзацы или ячейки таблицы не оформлены и Times New Roman, и Arial.
  23. 23. Все термины со строчной… или с прописной буквы. Какие бы сокращения и короткие названия вы ни использовали (Система, Заказчик, Исполнитель, др.), пишите их единообразно во всех документах проекта: – либо все со строчной, – либо все с прописной буквы.
  24. 24. Таблицы и рисунки оформляйте однотипно. Таблицы и рисунки должны быть проименованны. Однотипно! Добавляйте ссылки на таблицы и рисунки. Автособираемые оглавления: – Перечень таблиц – Перечень рисунков
  25. 25. Правильно «пробеливайте» Знак номера № от самого номера (числа) нужно отделять пробелом – в вёрстке используется короткий пробел (полукегельная) Не используйте: – Лишние пробелы между словами – Лишние переходы на новую строку между абзацами
  26. 26. Кавычки под 2 и Э – разные! Используйте только 1 из 2 видов. « » “ ”
  27. 27. Автозамена Ctrl+H Если дописываете или изменяете чужой документ, то воспользуйтесь автоматической заменой по всему тексту Ctrl+H. Замените: – коротенькие чёрточки на нужные: введите в поле «Заменить» [пробел][дефис][пробел], а в поле «Заменить на» [пробел][тире][пробел] – “ на « и ” на » – 2 пробела на 1 пробел – 2 перехода на новую строку на 1: ^p^p на ^p – сочетание «пробел^p» на просто ^p
  28. 28. А что исправляете Вы? Каких ещё банальных ошибок можно с легкостью избежать, чтобы результирующий документ стал качественным? beamteam.ru/2011/09/mistakes-in-documents/

×