<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>Блог НТЦ Метротек &#187; документация</title>
	<atom:link href="http://blog.metrotek.spb.ru/tag/dokumentatsiya/feed/" rel="self" type="application/rss+xml" />
	<link>http://blog.metrotek.spb.ru</link>
	<description>блог разработчиков</description>
	<lastBuildDate>Sat, 21 Jan 2012 12:36:22 +0000</lastBuildDate>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.3.1</generator>
		<item>
		<title>Буклет с помощью LaTeX на раз-два-три</title>
		<link>http://blog.metrotek.spb.ru/2011/04/15/buklet-s-pomoshhyu-latex-na-raz-dva-tri/</link>
		<comments>http://blog.metrotek.spb.ru/2011/04/15/buklet-s-pomoshhyu-latex-na-raz-dva-tri/#comments</comments>
		<pubDate>Fri, 15 Apr 2011 11:01:06 +0000</pubDate>
		<dc:creator>Екатерина Саковская</dc:creator>
				<category><![CDATA[разработка]]></category>
		<category><![CDATA[LaTeX]]></category>
		<category><![CDATA[документация]]></category>

		<guid isPermaLink="false">http://blog.metrotek.spb.ru/?p=2726</guid>
		<description><![CDATA[Пакет pdfpages для LaTeX позволяет втавлять в .tex файлы страницы из pdf-документов. Для вставки используется директива \includepdf[]{}, которая имеет множество параметров. Задавая определённые значения параметров можно любой pdf-документ преобразовать таким образом, чтобы впоследствии без труда распечатать его с двух сторон листа в виде брошюры нужного формата. Раз Создаем .tex файл, например, booklet.tex следующего содержания: \documentclass[a4paper]{article} [...]]]></description>
			<content:encoded><![CDATA[<p>Пакет <a href="http://www.ctan.org/tex-archive/macros/latex/contrib/pdfpages/">pdfpages</a> для LaTeX позволяет втавлять в .tex файлы страницы из pdf-документов. Для вставки используется директива <code>\includepdf[]{}</code>, которая имеет множество параметров. Задавая определённые значения параметров можно любой pdf-документ преобразовать таким образом, чтобы впоследствии без труда распечатать его с двух сторон листа в виде брошюры нужного формата.<span id="more-2726"></span> </p>
<p>                                                             <strong>Раз</strong></p>
<p>Создаем .tex файл, например, booklet.tex следующего содержания:<br />
<code><br />
\documentclass[a4paper]{article}<br />
\usepackage[final]{pdfpages}<br />
\begin{document}<br />
\includepdf[pages=-, booklet, landscape]{имя_файла.pdf}<br />
\end{document}<br />
</code></p>
<p>                                                <strong>Два</strong></p>
<p>Компилируем файл с помощью программы pdflatex:</p>
<p><code>pdflatex booklet.tex</code></p>
<p>В результате получаем нужный нам документ booklet.pdf.</p>
<p><strong>Три</strong></p>
<p>Распечатываем документ, выбрав двухстороннюю печать по длинной стороне. Вот и все, брошюра готова.</p>
<p>А теперь поподробнее о директиве \includepdf: она служит для вставки в .tex файл страниц pdf-документа в нужном для формирования брошюры виде. Обязательным параметром является имя преобразуемого pdf-документа. В качестве необязательных параметров можно передать номера страниц, которые мы хотим преобразовать в брошюру (<code>pages=-</code>  означает, что нужно преобразовать все страницы документа). Параметр <code>booklet</code> служит для расположения двух страниц на листе, <code>landscape</code> устанавливает альбомную ориентацию страницы.</p>
]]></content:encoded>
			<wfw:commentRss>http://blog.metrotek.spb.ru/2011/04/15/buklet-s-pomoshhyu-latex-na-raz-dva-tri/feed/</wfw:commentRss>
		<slash:comments>2</slash:comments>
		</item>
		<item>
		<title>&#171;Тестирование&#187; руководства пользователя</title>
		<link>http://blog.metrotek.spb.ru/2010/10/28/testirovanie-rukovodstva-polzovatelya/</link>
		<comments>http://blog.metrotek.spb.ru/2010/10/28/testirovanie-rukovodstva-polzovatelya/#comments</comments>
		<pubDate>Thu, 28 Oct 2010 07:48:19 +0000</pubDate>
		<dc:creator>Екатерина Саковская</dc:creator>
				<category><![CDATA[b3et]]></category>
		<category><![CDATA[разработка]]></category>
		<category><![CDATA[документация]]></category>

		<guid isPermaLink="false">http://blog.metrotek.spb.ru/?p=2333</guid>
		<description><![CDATA[Решили тут на днях провести &#171;тестирование&#187; одного из разделов руководства пользователя для нашего прибора Беркут-ЕТ. Раздел посвящён проведению асимметричного теста и содержит схему подключения прибора, описание пунктов меню и порядок действий для проведения анализа. Основным условием тестирования было то, что тестировщиком должен быть человек, никогда ранее не читавший руководство и не проводивший асимметричный тест. Раздел [...]]]></description>
			<content:encoded><![CDATA[<p>Решили тут на днях провести &#171;тестирование&#187; одного из разделов руководства пользователя для нашего прибора <a href="http://metrotek.spb.ru/b3et.html">Беркут-ЕТ</a>. Раздел посвящён проведению асимметричного теста и содержит схему подключения прибора, описание пунктов меню и порядок действий для проведения анализа.</p>
<p>Основным условием тестирования было то, что тестировщиком должен быть человек, никогда ранее не читавший руководство<span id="more-2333"></span> и не проводивший асимметричный тест. Раздел руководства был распечатан и передан для предварительного изучения коллеге  из отдела конструкторов, задачей которого было попытаться самостоятельно провести описанный в руководстве тест. Также было предоставлено все необходимое для подключения прибора по схеме, описанной в руководстве. </p>
<p>Итак, после того, как материал был изучен, прибор подключен в соответствии со схемой, осталось выполнить указания из руководства и провести анализ. Что, к сожалению, вызвало некоторые трудности, т.к. оказалось, что подробно были описаны не все настройки прибора.</p>
<p>В результате решили:<br />
   &#8212; по возможности описать все трудности, с которыми может столкнуться пользователь при настройке прибора;<br />
   &#8212; пореже отсылать пользователя к материалам, описанным в предыдущих разделах;<br />
   &#8212; увеличить количество поясняющих скриншотов;<br />
   &#8212; привести не абстрактный, а конкретный пример проведения тестирования. </p>
<p>Полученное описание снова было показано пользователю и признано более понятным. Но, как говорится, нет предела совершенству. ;)</p>
<p>Проведя такое &#171;тестирование&#187; документации мы ещё раз убедились в том, что не все то, что понятно программистам и техническому писателю понятно пользователю.</p>
<p>Итак, вперёд, к более подробной и, следовательно, понятной для пользователя документации!</p>
<p>P.S. Большое спасибо тестировщику за дельные советы и интересные идеи. :)<br />
P.P.S. А еще оказалось, что тестирование руководства пользователя полезно и для программистов: в результате тестирования было решено упростить для понимания<br />
пользователя один из пунктов меню прибора. </p>
]]></content:encoded>
			<wfw:commentRss>http://blog.metrotek.spb.ru/2010/10/28/testirovanie-rukovodstva-polzovatelya/feed/</wfw:commentRss>
		<slash:comments>11</slash:comments>
		</item>
		<item>
		<title>LaTeX. Использование пакета bytefield</title>
		<link>http://blog.metrotek.spb.ru/2010/02/04/latex-ispolzovanie-paketa-bytefield/</link>
		<comments>http://blog.metrotek.spb.ru/2010/02/04/latex-ispolzovanie-paketa-bytefield/#comments</comments>
		<pubDate>Thu, 04 Feb 2010 13:57:13 +0000</pubDate>
		<dc:creator>Екатерина Саковская</dc:creator>
				<category><![CDATA[интересное]]></category>
		<category><![CDATA[LaTeX]]></category>
		<category><![CDATA[документация]]></category>

		<guid isPermaLink="false">http://blog.metrotek.spb.ru/?p=1698</guid>
		<description><![CDATA[Пакет для LaTeX bytefield позволяет создавать иллюстрации для описания сетевых протоколов. Точнее, иллюстрации, отображающие структуру кадров, используемых сетевыми протоколами для передачи данных. Почитав описание этого пакета, решила попробовать применить его на практике, т.к. в процессе написания руководства пользователя для Беркут-ET сталкивалась с необходимостью приводить рисунок со структурой Ethernet-кадра. Результаты оказались очень и очень положительными. Время, [...]]]></description>
			<content:encoded><![CDATA[<p><img src="http://blog.metrotek.spb.ru/wp-content/uploads/2010/02/ipv4_color-150x150.png" alt="" title="ipv4_color" width="150" height="150" class="alignleft size-thumbnail wp-image-1715" /> Пакет для LaTeX <a href="http://www.ctan.org/tex-archive/macros/latex/contrib/bytefield/">bytefield</a> позволяет создавать иллюстрации для описания сетевых протоколов. Точнее, иллюстрации, отображающие структуру кадров, используемых сетевыми протоколами для передачи данных. Почитав описание этого пакета, решила попробовать применить его на практике, т.к. в процессе написания руководства пользователя для Беркут-ET сталкивалась с необходимостью приводить рисунок со структурой Ethernet-кадра.</p>
<p>Результаты оказались очень и очень положительными. Время, которое было потрачено на то, чтобы<span id="more-1698"></span> разобраться с особенностями пакета bytefield, с лихвой окупилось полученным результатом. В качестве примера приведу картинку, изображающую структуру пакета IPv4, полученную с использованием возможностей пакета bytefield:</p>
<p><a href="http://blog.metrotek.spb.ru/wp-content/uploads/2010/02/ipv4.png"><img class="aligncenter size-full wp-image-1700" src="http://blog.metrotek.spb.ru/wp-content/uploads/2010/02/ipv4.png" alt="" width="623" height="355" /></a></p>
<p>Текст документа для получения этой красивой картинки:</p>
<pre>
    \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} &amp;
    \bitbox{4}{Header length} &amp;
    \bitbox{8}{Differentiated Services} &amp;
    \bitbox{16}{Total Length}\\
    \bitbox{16}{Identification} &amp;
    \bitbox{3}{Flags} &amp;
    \bitbox{13}{Fragment Offset}\\
    \bitbox{8}{Time to Live} &amp;
    \bitbox{8}{Protocol} &amp;
    \bitbox{16}{Header Checksum}\\
    \bitbox{32}{Source Address} \\
    \bitbox{32}{Destination Address} \\
    \bitbox{32}{Options (if Header Length &gt; 5)}
    \endwordgroupr \\
    \bitbox{32}{Data}\\
    \end{bytefield}
</pre>
<p>Для получения цветной картинки нужно:</p>
<ul>
<li> определить команду <code>\colorbitbox</code>:
<pre>
    \newcommand{\colorbitbox}[3]{%
    \rlap{\bitbox{#2}{\color{#1}\rule{\width}{\height}}}%
    \bitbox{#2}{#3}}
</pre>
<li>определить цвета:
<pre>
    \definecolor{lightpink}{rgb}{1,0.7,0.7}
    \definecolor{lightcyan}{rgb}{0.84,1,1}
    \definecolor{peachpuff}{rgb}{1,0.85,0.73}
</pre>
<li>вместо команды <code>\bitbox</code> использовать команду <code>\colorbitbox</code>, например:
<pre>
    \colorbitbox{peachpuff}{4}{Version}
</pre>
<p> (вместо <code>\bitbox{4}{Version})
</ul>
<p>А вот и результат:</p>
<p><a href="http://blog.metrotek.spb.ru/wp-content/uploads/2010/02/ipv4_color.png"><img class="aligncenter size-full wp-image-1715" src="http://blog.metrotek.spb.ru/wp-content/uploads/2010/02/ipv4_color.png" alt="" width="623" height="359" /></a></p>
]]></content:encoded>
			<wfw:commentRss>http://blog.metrotek.spb.ru/2010/02/04/latex-ispolzovanie-paketa-bytefield/feed/</wfw:commentRss>
		<slash:comments>4</slash:comments>
		</item>
		<item>
		<title>LaTeX. Предметный указатель и оглавление</title>
		<link>http://blog.metrotek.spb.ru/2010/01/27/latex-predmetnyiy-ukazatel-i-oglavlenie/</link>
		<comments>http://blog.metrotek.spb.ru/2010/01/27/latex-predmetnyiy-ukazatel-i-oglavlenie/#comments</comments>
		<pubDate>Wed, 27 Jan 2010 13:13:42 +0000</pubDate>
		<dc:creator>Екатерина Саковская</dc:creator>
				<category><![CDATA[интересное]]></category>
		<category><![CDATA[разработка]]></category>
		<category><![CDATA[LaTeX]]></category>
		<category><![CDATA[документация]]></category>

		<guid isPermaLink="false">http://blog.metrotek.spb.ru/?p=1649</guid>
		<description><![CDATA[В свое время, в процессе создания руководства пользователя для Беркут-ET  в системе LaTeX, возникла следующая проблемка: при сборке документации ссылка на предметный указатель не отображалась в оглавлении. Как оказалось, для того, чтобы эта ссылка появилась, необходимо переопределить в стилевом файле команду \theindex, добавив в необязательный аргумент команды \twocolumn команду \addcontentsline: \renewcommand{\theindex}{\@restonecoltrue \if@twocolumn\@restonecolfalse\fi \columnseprule=0pt \columnsep=35pt %%%%%%%%%%%%%%% [...]]]></description>
			<content:encoded><![CDATA[<p>В свое время, в процессе создания руководства пользователя для Беркут-ET  в системе LaTeX, возникла следующая проблемка: при сборке документации ссылка на предметный указатель не отображалась в оглавлении.</p>
<p>Как оказалось, для того, чтобы эта ссылка появилась, необходимо переопределить в стилевом файле команду <code>\theindex</code>, добавив в необязательный аргумент команды <code>\twocolumn</code> команду <code>\addcontentsline</code>:<span id="more-1649"></span><br />
<code><br />
\renewcommand{\theindex}{\@restonecoltrue<br />
\if@twocolumn\@restonecolfalse\fi<br />
\columnseprule=0pt \columnsep=35pt<br />
%%%%%%%%%%%%%%%<br />
\twocolumn[\@makeschapterhead{\indexname}\addcontentsline{toc}{chapter}{\indexname}]<br />
%%%%%%%%%%%%%%%<br />
\@mkboth{\uppercase{\indexname}}{\uppercase{\indexname}}<br />
\thispagestyle{plain}\parindent=0pt<br />
\setlength{\parskip}{0pt plus .3pt}%<br />
\let\item=\@idxitem}<br />
</code><br />
Решение было найдено в книге С. М. Львовского &#171;Набор и верстка в пакете LaTeX&#187;.</p>
]]></content:encoded>
			<wfw:commentRss>http://blog.metrotek.spb.ru/2010/01/27/latex-predmetnyiy-ukazatel-i-oglavlenie/feed/</wfw:commentRss>
		<slash:comments>3</slash:comments>
		</item>
	</channel>
</rss>

