Что нельзя писать в тексте технического задания (ТЗ)?

0
Акашева Василиса Игоревна1/21/2021

Текст документа должен быть кратким, четким и не допускать различных толкований. При изложении обязательных требований в тексте должны применяться слова «должен», «следует», «необходимо», «требуется, чтобы», «разрешается только», «не допускается», «запрещается», «не следует». При изложении других положений следует применять слова «могут быть», «как правило», «при необходимости», «может быть», «в случае» и т. д.

При этом допускается использовать повествовательную форму изложения текста документа, например: «применяют», «указывают» и т. п.

В документах должны применяться научно-технические термины, обозначения и определения, установленные соответствующими стандартами, а при их отсутствии — общепринятые в научно-технической литературе.

Если в документе принята специфическая терминология, то в конце его (перед списком литературы) должен быть перечень принятых терминов с соответствующими разъяснениями. Перечень включают в содержание документа.

В тексте документа не допускается:

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

В тексте документа, за исключением формул, таблиц и рисунков, не допускается:

  • применять математический знак минус (-) перед отрицательными значениями величин (следует писать слово «минус»);
  • применять знак ⍉ для обозначения диаметра (следует писать слово «диаметр»);
  • применять без числовых значений математические знаки, например: > (больше), < (меньше), = (равно), ≥ (больше или равно), ≤(меньше или равно), ≠ (не равно), а также знаки № (номер), % (процент);
  • применять индексы стандартов, технических условий и других документов без регистрационного номера.

Если в документе приводятся поясняющие надписи, наносимые непосредственно на изготовляемое изделие (например, на планки, таблички к элементам управления и т. п.), их выделяют прописными буквами (без кавычек), например: ВКЛ., ОТКЛ., или кавычками, если надпись состоит из цифр и (или) знаков.

Наименования команд, режимов, сигналов и т. п. в тексте следует выделять кавычками, например: «Сигнал +27 В включен».

В тексте документа числовые значения величин с обозначением единиц физических величин и единиц счета следует писать цифрами, а числа от единицы до девяти без обозначения единиц физических величин и единиц счета — словами

Глаголев В. А. Разработка технической документации: Руководство для технических писателей и локализаторов ПО (+CD). — СПб.: Питер, 2008. — С. 47-48.
Следующая статья
Бизнес и экономика
Почему одни профессии оплачиваются выше других: взгляд Адама Смита
Неравенства, обусловливаемые самим характером занятий  Пять следующих главных условий, насколько я мог наблюдать, компенсируют малый денежный заработок в одних занятиях и уравновешивают больший заработок в других: 1) приятность или неприятность самих занятий, 2) легкость и дешевизна или трудность и дороговизна обучения им, 3) постоянство или непостоянство занятий, 4) большее или меньшее доверие, оказываемое тем лицам, которые занимаются ими, и 5) вероятность или невероятность успеха в них.Адам Смит (1723 – 1790) – экономист, один из основоположников эконо...
Бизнес и экономика
Почему одни профессии оплачиваются выше других: взгляд Адама Смита
Бизнес и экономика
«Трудности» перевода в IT-проектах и как их преодолеть
Бизнес и экономика
Уставы Пахомия: переход от индивидуальной практики к зачаткам корпоративной культуры в IV веке
Бизнес и экономика
Иллюзия работы, или почему не работает самодиагностика процессов на предприятии
Бизнес и экономика
Junior UX/UI собеседование: как произвести впечатление на будущих коллег?
Бизнес и экономика
Как соревнование и конкуренция ведут общество вперёд
Бизнес и экономика
Один в поле не воин, или как собирать рацпредложения на предприятии
Бизнес и экономика
Чем полезно разделение труда: выдержки из Адама Смита
Бизнес и экономика
Как фиксировать и внедрять лучшие практики в компании – инженер Гаррингтон Эмерсон
Бизнес и экономика
Концептуальная целостность по Фредерику Бруксу – на примере интерфейса WIMP
Бизнес и экономика
Как спровоцировать клиента на импульсивные покупки
Бизнес и экономика
Как и когда появились первые кредитные карты
Бизнес и экономика
Что делать, если не получилось делегировать? Схема передачи работы другому сотруднику
Бизнес и экономика
Решает ли бизнес-проблемы теория ограничений системы Элияху Голдратта?
Бизнес и экономика
«Производственная система Тойоты. Уходя от массового производства» – реферат: самое главное из книги Тайити Оно
Бизнес и экономика
Конвергенция как основа для инноваций – Питер Друкер