документация — НТЦ Метротек. Архив блога http://blog.metrotek.spb.ru заметки бывших разработчиков бывшего НТЦ Метротек Thu, 02 Oct 2025 13:52:15 +0000 ru-RU hourly 1 https://wordpress.org/?v=5.1.15 ГОСТ и КД http://blog.metrotek.spb.ru/2015/01/27/gost-i-kd/ Tue, 27 Jan 2015 15:13:14 +0000 http://blog.metrotek.spb.ru/?p=4916 недавно мы озаботились получением так называемого «четырёхзначного буквенного кода организации-разработчика» для использования в конструкторской документации, оформляемой по ГОСТу, и наконец его получили. теперь, если вы увидите в КД на изделие буквы «МТРГ», то знайте — это наше.

]]>
Беркут-ETX. Обновление ПО http://blog.metrotek.spb.ru/2013/09/25/berkut-etx-obnovlenie-po/ Wed, 25 Sep 2013 07:39:49 +0000 http://blog.metrotek.spb.ru/?p=4382 Анализатор 10G ethernet

Анализатор 10G ethernet

немного посовещавшись, мы решили, что хорошо бы добавить некоторые пояснения к процессу обновления программного обеспечения для Беркут-ETX.

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

а нюансы следующие:

  • выключить контроль потока (flow control) в терминальной программе
  • не пытаться ввести ATR на выключенном приборе
  • правильно нажимать на скрытую кнопку сброса (до лёгкого щелчка), удерживая нажатой клавишу on/off

обновлённая инструкция — вот.

]]>
Руководства пользователя для ET и ETX http://blog.metrotek.spb.ru/2013/09/23/rukovodstva-polzovatelya-dlya-et-i-etx/ Mon, 23 Sep 2013 13:28:17 +0000 http://blog.metrotek.spb.ru/?p=4379 как всегда, неожиданно выяснилось, что на сайте были выложены не все файлы с документацией по нашим приборам Беркут-ET и Беркут-ETX. исправляем эту досадную ошибку и сообщаем, что теперь в руководствах по эксплуатации есть описание режимов тестирования по Y.1564, а также поддержки протокола точного времени PTP.

юзер-гайды для Беркут-ET лежат тут, а для Беркут-ETXздесь.

скачивайте самый свежий файл, не ошибётесь.

счастливых обладателей самых лучших в мире тестеров-анализаторов ethernet просим не стесняться, скачивать, читать и задавать вопросы.

]]>
Буклет с помощью LaTeX на раз-два-три http://blog.metrotek.spb.ru/2011/04/15/buklet-s-pomoshhyu-latex-na-raz-dva-tri/ http://blog.metrotek.spb.ru/2011/04/15/buklet-s-pomoshhyu-latex-na-raz-dva-tri/#comments Fri, 15 Apr 2011 11:01:06 +0000 http://blog.metrotek.spb.ru/?p=2726 Пакет pdfpages для LaTeX позволяет втавлять в .tex файлы страницы из pdf-документов. Для вставки используется директива \includepdf[]{}, которая имеет множество параметров. Задавая определённые значения параметров можно любой pdf-документ преобразовать таким образом, чтобы впоследствии без труда распечатать его с двух сторон листа в виде брошюры нужного формата.

Раз

Создаем .tex файл, например, booklet.tex следующего содержания:

\documentclass[a4paper]{article}
\usepackage[final]{pdfpages}
\begin{document}
\includepdf[pages=-, booklet, landscape]{имя_файла.pdf}
\end{document}

Два

Компилируем файл с помощью программы pdflatex:

pdflatex booklet.tex

В результате получаем нужный нам документ booklet.pdf.

Три

Распечатываем документ, выбрав двухстороннюю печать по длинной стороне. Вот и все, брошюра готова.

А теперь поподробнее о директиве \includepdf: она служит для вставки в .tex файл страниц pdf-документа в нужном для формирования брошюры виде. Обязательным параметром является имя преобразуемого pdf-документа. В качестве необязательных параметров можно передать номера страниц, которые мы хотим преобразовать в брошюру (pages=- означает, что нужно преобразовать все страницы документа). Параметр booklet служит для расположения двух страниц на листе, landscape устанавливает альбомную ориентацию страницы.

]]>
http://blog.metrotek.spb.ru/2011/04/15/buklet-s-pomoshhyu-latex-na-raz-dva-tri/feed/ 2
«Тестирование» руководства пользователя http://blog.metrotek.spb.ru/2010/10/28/testirovanie-rukovodstva-polzovatelya/ http://blog.metrotek.spb.ru/2010/10/28/testirovanie-rukovodstva-polzovatelya/#comments Thu, 28 Oct 2010 07:48:19 +0000 http://blog.metrotek.spb.ru/?p=2333 Решили тут на днях провести «тестирование» одного из разделов руководства пользователя для нашего прибора Беркут-ЕТ. Раздел посвящён проведению асимметричного теста и содержит схему подключения прибора, описание пунктов меню и порядок действий для проведения анализа.

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

Итак, после того, как материал был изучен, прибор подключен в соответствии со схемой, осталось выполнить указания из руководства и провести анализ. Что, к сожалению, вызвало некоторые трудности, т.к. оказалось, что подробно были описаны не все настройки прибора.

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

Полученное описание снова было показано пользователю и признано более понятным. Но, как говорится, нет предела совершенству. ;)

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

Итак, вперёд, к более подробной и, следовательно, понятной для пользователя документации!

P.S. Большое спасибо тестировщику за дельные советы и интересные идеи. :)
P.P.S. А еще оказалось, что тестирование руководства пользователя полезно и для программистов: в результате тестирования было решено упростить для понимания
пользователя один из пунктов меню прибора.

]]>
http://blog.metrotek.spb.ru/2010/10/28/testirovanie-rukovodstva-polzovatelya/feed/ 11
LaTeX. Использование пакета bytefield http://blog.metrotek.spb.ru/2010/02/04/latex-ispolzovanie-paketa-bytefield/ http://blog.metrotek.spb.ru/2010/02/04/latex-ispolzovanie-paketa-bytefield/#comments Thu, 04 Feb 2010 13:57:13 +0000 http://blog.metrotek.spb.ru/?p=1698 Пакет для LaTeX bytefield позволяет создавать иллюстрации для описания сетевых протоколов. Точнее, иллюстрации, отображающие структуру кадров, используемых сетевыми протоколами для передачи данных. Почитав описание этого пакета, решила попробовать применить его на практике, т.к. в процессе написания руководства пользователя для Беркут-ET сталкивалась с необходимостью приводить рисунок со структурой Ethernet-кадра.

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

Текст документа для получения этой красивой картинки:

    \setlength{\bitwidth}{3.5mm}
    \setlength{\byteheight}{10mm}

    \begin{bytefield}{32}
    \bitheader{0,3,4,7,8,15,16,18,19,31}\\
    \wordgroupr{Header}
    \bitbox{4}{Version} &
    \bitbox{4}{Header length} &
    \bitbox{8}{Differentiated Services} &
    \bitbox{16}{Total Length}\\
    \bitbox{16}{Identification} &
    \bitbox{3}{Flags} &
    \bitbox{13}{Fragment Offset}\\
    \bitbox{8}{Time to Live} &
    \bitbox{8}{Protocol} &
    \bitbox{16}{Header Checksum}\\
    \bitbox{32}{Source Address} \\
    \bitbox{32}{Destination Address} \\
    \bitbox{32}{Options (if Header Length > 5)}
    \endwordgroupr \\
    \bitbox{32}{Data}\\
    \end{bytefield}

Для получения цветной картинки нужно:

  • определить команду \colorbitbox:
        \newcommand{\colorbitbox}[3]{%
        \rlap{\bitbox{#2}{\color{#1}\rule{\width}{\height}}}%
        \bitbox{#2}{#3}}
    
  • определить цвета:
        \definecolor{lightpink}{rgb}{1,0.7,0.7}
        \definecolor{lightcyan}{rgb}{0.84,1,1}
        \definecolor{peachpuff}{rgb}{1,0.85,0.73}
    
  • вместо команды \bitbox использовать команду \colorbitbox, например:
        \colorbitbox{peachpuff}{4}{Version}
    

    (вместо \bitbox{4}{Version})

А вот и результат:

]]>
http://blog.metrotek.spb.ru/2010/02/04/latex-ispolzovanie-paketa-bytefield/feed/ 4
LaTeX. Предметный указатель и оглавление http://blog.metrotek.spb.ru/2010/01/27/latex-predmetnyiy-ukazatel-i-oglavlenie/ http://blog.metrotek.spb.ru/2010/01/27/latex-predmetnyiy-ukazatel-i-oglavlenie/#comments Wed, 27 Jan 2010 13:13:42 +0000 http://blog.metrotek.spb.ru/?p=1649 В свое время, в процессе создания руководства пользователя для Беркут-ET  в системе LaTeX, возникла следующая проблемка: при сборке документации ссылка на предметный указатель не отображалась в оглавлении.

Как оказалось, для того, чтобы эта ссылка появилась, необходимо переопределить в стилевом файле команду \theindex, добавив в необязательный аргумент команды \twocolumn команду \addcontentsline:

\renewcommand{\theindex}{\@restonecoltrue
\if@twocolumn\@restonecolfalse\fi
\columnseprule=0pt \columnsep=35pt
%%%%%%%%%%%%%%%
\twocolumn[\@makeschapterhead{\indexname}\addcontentsline{toc}{chapter}{\indexname}]
%%%%%%%%%%%%%%%
\@mkboth{\uppercase{\indexname}}{\uppercase{\indexname}}
\thispagestyle{plain}\parindent=0pt
\setlength{\parskip}{0pt plus .3pt}%
\let\item=\@idxitem}

Решение было найдено в книге С. М. Львовского «Набор и верстка в пакете LaTeX».

]]>
http://blog.metrotek.spb.ru/2010/01/27/latex-predmetnyiy-ukazatel-i-oglavlenie/feed/ 3