Posts Tagged ‘документация’

ГОСТ и КД

недавно мы озаботились получением так называемого «четырёхзначного буквенного кода организации-разработчика» для использования в конструкторской документации, оформляемой по ГОСТу, и наконец его получили. теперь, если вы увидите в КД на изделие буквы «МТРГ», то знайте — это наше.

Беркут-ETX. Обновление ПО

немного посовещавшись, мы решили, что хорошо бы добавить некоторые пояснения к процессу обновления программного обеспечения для . потому что, как показали недавно проведённые бесчеловечные эксперименты, непосвящённому в детали пользователю обновить прошивку не так просто. успех ждёт, в среднем, с пятой попытки. не потому, что руки кривые или механизм обновления не работает. вовсе нет. всё дело, […]

Руководства пользователя для ET и ETX

как всегда, неожиданно выяснилось, что на сайте были выложены не все файлы с документацией по нашим приборам и . исправляем эту досадную ошибку и сообщаем, что теперь в руководствах по эксплуатации есть описание режимов тестирования по Y.1564, а также поддержки протокола точного времени PTP. юзер-гайды для лежат тут, а для — здесь. скачивайте самый свежий […]

Буклет с помощью LaTeX на раз-два-три

Пакет pdfpages для LaTeX позволяет втавлять в .tex файлы страницы из pdf-документов. Для вставки используется директива \includepdf[]{}, которая имеет множество параметров. Задавая определённые значения параметров можно любой pdf-документ преобразовать таким образом, чтобы впоследствии без труда распечатать его с двух сторон листа в виде брошюры нужного формата.

«Тестирование» руководства пользователя

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

LaTeX. Использование пакета bytefield

Пакет для LaTeX bytefield позволяет создавать иллюстрации для описания сетевых протоколов. Точнее, иллюстрации, отображающие структуру кадров, используемых сетевыми протоколами для передачи данных. Почитав описание этого пакета, решила попробовать применить его на практике, т.к. в процессе написания руководства пользователя для Беркут-ET сталкивалась с необходимостью приводить рисунок со структурой Ethernet-кадра. Результаты оказались очень и очень положительными. Время, […]

LaTeX. Предметный указатель и оглавление

В свое время, в процессе создания руководства пользователя для Беркут-ET  в системе LaTeX, возникла следующая проблемка: при сборке документации ссылка на предметный указатель не отображалась в оглавлении. Как оказалось, для того, чтобы эта ссылка появилась, необходимо переопределить в стилевом файле команду \theindex, добавив в необязательный аргумент команды \twocolumn команду \addcontentsline: