Основной принцип
Любая техническая запись должна иметь источник и контекст применимости.
Минимальные поля источника
- Производитель / организация-издатель
- Полное название документа
- URL официальной страницы или документа
- Редакция / версия / дата выпуска
- Страница или раздел
- Дата проверки записи
- Модель, поколение, аппаратная ревизия и версия ПО, если применимо
- Статус проверки
Статусы
verified_primary_source— проверено по первичному источнику.needs_review— данных недостаточно; не выдавать за инструкцию.conflicting_sources— источники расходятся; требуется экспертная проверка.historical_unverified— архивная запись без достаточного подтверждения.do_not_publish— опасно или невозможно подтвердить.
ЧПУ и ошибки
Код ошибки нельзя сопоставлять только по номеру. Нужны производитель, семейство, точная модель/поколение и версия ПО. Не показывать восстановительные действия, отключение защит или обход блокировок без подтверждённого руководства производителя. Для неподтверждённых записей показывать только сообщение, что источник не найден.
Материалы и режимы обработки
Числа должны сопровождаться единицами, типом операции, инструментом, состоянием материала, жёсткостью/условиями установки и ссылкой на источник. Калькуляторы дают математический результат, но не выбирают автоматически безопасный технологический режим.
Права на контент
Не копировать целиком защищённые руководства, таблицы или базы данных без разрешения. Предпочитать ссылки на официальные документы, собственные краткие описания и метаданные.
Долгосрочная устойчивость
Хранить исходные файлы, контрольные суммы, дату получения и журнал изменений. Регулярно делать резервные копии.