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

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

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

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

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

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

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

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

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

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

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

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

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

Глаголев В. А. Разработка технической документации: Руководство для технических писателей и локализаторов ПО (+CD). — СПб.: Питер, 2008. — С. 47-48.
Следующая статья
Искусство и дизайн
Кодекс честного сотрудничества: правила, которые защитят заказчиков и исполнителей
Кодекс честного предпринимательства был написан и впервые опубликован в 1948 году и предназначен для использования в сфере графической коммуникации. Он был пересмотрен в 1989 году и с тех пор тысячи художников и графических дизайнеров, живущих и работающих в США, пользуются им как руководством по справедливым отношениям с заказчиками. Если вы действуете в соответствии с положениями Кодекса, то это помогает вам становить равноправные отношения с клиентами, поскольку и вы, и ваш клиент Вы оба обязуетесь соблюдать этические и профессиональные нормы. Кодекс ч...
Искусство и дизайн
Кодекс честного сотрудничества: правила, которые защитят заказчиков и исполнителей
Бизнес и экономика
Как провести эффективное совещание: простые правила для продуктивных встреч
Бизнес и экономика
Как неверная организация процессов ведет к неэффективности
Бизнес и экономика
Иллюзия работы, или почему не работает самодиагностика процессов на предприятии — Часть 2
Бизнес и экономика
Трудности принятия решений на уровне отдела: анализ и решения от Стэнли Янга
Бизнес и экономика
Процесс системы управления по Стэнли Янгу
Бизнес и экономика
Ошибки управления на примере авиации: как плохая координация разрушает эффективность работы отдела
Бизнес и экономика
Как диагностировать проблемы управления в отделе: методы Стэнли Янга
Бизнес и экономика
Экономика рабства: почему рабский труд оказывается менее выгодным, чем свободный
Бизнес и экономика
Два случая, когда выгодно облагать налогом иностранную промышленность, по Адаму Смиту
Бизнес и экономика
Пиратский кодекс — десять соглашений
Бизнес и экономика
Какими должны быть визитные карточки
Бизнес и экономика
Лучшие практики на службе у «Американского Красного Креста»
Бизнес и экономика
Как напугать социальной рекламой с помощью Л. С. Выготского
Бизнес и экономика
СамоНеОрганизация. Почему посиделки у кулера не помогут работать лучше
Бизнес и экономика
Почему люди не будут пользоваться знаниями, инструментами и практиками