Грабли

Единицы, оси и другие признаки цивилизации

Число без единицы часто бесполезно.

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

Техническая дисциплина требует явно обозначать:

  • единицы измерения;
  • систему координат;
  • масштаб;
  • источник данных;
  • дату;
  • версию;
  • условные обозначения;
  • допущения;
  • диапазон применимости.

На графике должны быть подписаны оси. На схеме — легенда. В расчёте — исходные данные и формулы. В документе — статус и версия.

Эти элементы кажутся лишними автору, потому что он помнит контекст. Документ обычно переживает эту память.

Не следует запрещать предположения вообще. Без них невозможно проектировать, прогнозировать и принимать решения при неполной информации.

Предположение должно быть:

  • явным;
  • обоснованным;
  • проверяемым;
  • достаточно консервативным при риске;
  • пересмотренным после появления данных.

Фраза «не знаю всех условий, поэтому не имею права предлагать решение» иногда разумна. Иногда она становится способом никогда не принимать решение.

Точнее сказать:

При таких исходных данных и таких допущениях наиболее обоснованным выглядит этот вариант. Если условие изменится, решение надо пересмотреть.

Техническая честность состоит не в отсутствии неопределённости. Она состоит в том, чтобы неопределённость не была спрятана между строками.

Дороже всего обходятся числа, у которых единица подразумевается. «Стакан муки» весит где-то от ста двадцати до ста восьмидесяти граммов, и тесто честно показывает разницу. Зазор «0,5» без указания миллиметров однажды приезжает на площадку в виде детали, которую надо переделывать за свой счёт. Автор в обоих случаях прекрасно знал, что имел в виду. Это знание просто не поехало вместе с документом.

Документ живёт дольше памяти автора и почти всегда попадает к человеку, которого уже не спросишь: он в другой компании, в другом городе или просто не помнит. Подписанная ось — не педантизм, а способ не присутствовать лично при каждом будущем прочтении.