О документах

Контроль качества технической документации. Этот пост о типичных ошибках, которые допускаются при составлении технической документации. Многие ошибки обусловлены просто невнимательностью. Итак, вот некоторые моменты, на которые нужно обратить внимание: ✔️Название системы должно полностью совпадать с контрактом или другим официальным документом, инициирующим разработку. Если в этом документе используется и полное и сокращенное название системы, то следует выбрать один вариант и использовать только его во всей документации. ✔️Когда упоминается Заказчик, нужно использовать официальное название компании и оно должно совпадать с тем, что прописано в контракте. ✔️Обозначения/наименования компонентов системы, которые упоминаются в описательной части, должны совпадать с обозначением в спецификации. ✔️Децимальный номер проекта должен быть одинаковым везде. Вариант, когда в одном месте АБВГ.1245668.С5, а в другом АБВГ-12345668.С5 недопустим. ✔️Если подрядчик нанимает субподрядчика, то в документации, которая готовится подрядчиком для заказчика это никак не должно отражаться, если иное не прописано в контракте. То есть, нанимая субподрядчика нужно сразу донести до него, что в документации всё должно выглядеть так, как будто это разработано подрядчиком, т.к. контракт заключён с ним и ответственность за разработку перед заказчиком несёт он. ⠀ В карусели пояснительные картинки👉