Оценка плана документирования
Использование настоящего стандарта во взаимоотношениях между заказчиком и документатором способствует созданию качественной документации в частности потому, что между ними согласовывается план документирования. Этим достигается двойной эффект: во-первых, документатор учитывает все аспекты документации, оговоренные в плане; во-вторых, заказчик и документатор согласуют метод документирования, определенный в плане, еще до начала работы.
Заказчик должен установить наличие в плане документирования следующих элементов:
a) соответствующих определений всех аудиторий. Формулировка вида «Руководство предназначено для аудитории, охватывающей пользователей программного средства» неполна (см. приложение D). В определение аудитории должны быть включены все лица, могущие использовать данное программное средство (включая лиц, которые могут только просматривать отчеты или сообщения от данного средства);
b) содержания (планов-проспектов) документации с оценкой их постраничного объема;
c) определения числа печатных копий и методов печати (тиражирования) и брошюровки документации;
d) однозначного определения собственника авторских прав на документацию;
e) установление методов подготовки документации. Большинство технических документов может быть создано при помощи компьютера;
f) достаточных сроков для проверки заказчиком редакций документации. Любые отсрочки при возврате документатору проверенных редакций могут привести к срыву сроков поставки документации;
g) от организации-заказчика может потребоваться обеспечение документатора соответствующими ресурсами (доступом к ее персоналу, оборудованием и т. д.), при отсутствии которых работы могут быть сорваны.
В целом план документирования должен учитывать все специфические обстоятельства, относящиеся к организации-заказчику и пользователям. Крайне маловероятна возможность использования плана документирования, разработанного в рамках одного проекта, для другого.
ПРИЛОЖЕНИЕ Н (справочное)Образец спецификации стиля
Н.1 Общие положения
Представленный образец спецификации стиля документации соответствует требованиям 8.2 и по умолчанию может быть использован в плане документирования.
Примечание — Перед окончательным принятием данной спецификации полезно создать на ее основе модель документа.
Н.2 Элементы стиля
В таблице Н.1 приведены элементы стиля и их рекомендуемые значения по умолчанию.
Таблица Н.1 — Элементы стиля и их значения
| Язык | Английский |
|---|---|
| Орфографический словарь | Словарь Маквайра |
| Руководство по грамматике и использованию стиля | «Руководство по стилю для авторов, редакторов и издателей» Австралийское государственное издательство |
| Формат бумаги | A4 |
| Ориентация | Книжная (вертикальная) |
| Вид печати | Двусторонняя |
| Разрешающая способность типографской или лазерной печати | Минимум 300 точек/дюйм |
| Ширина внутреннего поля | 10 мм/2,4 цицеро[2] |
| Ширина внешнего поля | 10 мм/2,4 цицеро[2] |
| Цвет краски | Черный |
| Цвет, масса и вид бумаги | Белая, 80 г/см², матовая |
| Разделители | Нет |
| Переплет | Пластиковый комбинированный, с прозрачной верхней и черной нижней обложками, плотностью 200–260 г/см² |
| Метод воспроизведения и качество | Все материалы должны быть пригодными к фотокопированию и не иметь помарок и обесцвечиваний |
| Схема нумерации страниц | Страницы нумеруют в формате 1, 2, 3 и т. д., начиная с первой после обложки |
| Нумерация таблиц и рисунков | Рисунки нумеруют в формате «Рисунок 1», «Рисунок 2» и т. д., в порядке их появления в тексте документа. Таблицы нумеруют в формате «Таблица 1», «Таблица 2» и т. д., в порядке их появления в тексте документа |
| Число колонок | Одна |
| Сноски или концевые примечания | Не используют |
| Правила пагинации | Заголовки не должны попадать в конец страницы. Таблицы объемом менее страницы должны размещаться на одной странице. Каждый заголовок первого уровня должен располагаться вверху правой страницы |
| Правила плотности документа | Взаимосвязанные материалы следует размещать на одной странице или на ее обороте. Следует по возможности избегать использования подчеркивания, больших кусков, набранных жирным шрифтом, и текстов, целиком набранных заглавными буквами. Материалы должны занимать от 40 % до 60 % общего объема страницы |
| Вводные и вспомогательные материалы: | |
| - титульный лист | На титульном листе должно быть указано наименование продукции, ее версия, дата выпуска документа и название данного тома |
| - информация о гарантиях, авторских правах и торговой марке | Не приводится |
| - содержание | В содержании должны быть приведены заголовки всех частей, глав и разделов с указанием номеров страниц |
| - список рисунков и таблиц | Не приводится |
| - приложения | Не предусмотрены |
| - глоссарий | В глоссарии должен быть определен любой термин, неизвестный аудитории пользователей документа, в терминах, знакомых данной аудитории |
| - перечни обозначений и сокращений | Следует указать все встречающиеся в тексте обозначения и сокращения. Если данные элементы не являются очевидными по смыслу, они должны быть пояснены соответствующим текстом |
| - указатель | В соответствии с Н.3 |
| - порядок | Располагаются в порядке их перечисления в настоящей таблице, основная часть документа располагается между содержанием и глоссарием |
| Гарнитуры шрифтов и кегли текста основной части документа | Times Roman, 12 п |
| Отступы по горизонтали и пробелы по вертикали в тексте основной части | Текст основной части должен иметь общий отступ на 2 п и левосторонний отступ на 30 мм/7 цицеро. Между абзацами должен быть вертикальный пробел в одну строку |
| Выравнивание текста основной части | Текст основной части должен быть выровнен по левой стороне с неровностями по правому краю |
| Количество уровней и наименования заголовков | Четыре; заголовки части, главы, раздела и подраздела |
| Стиль текста заголовков | Все заголовки должны быть изложены в повествовательном стиле с заглавной буквы и без точки в конце |
| Гарнитуры шрифтов, кегли и отступы для каждого уровня заголовков | Все заголовки оформляют шрифтом Times Roman следующими кеглями: заголовок части — 36 п, главы — 24 п, раздела — 18 п, подраздела — 14 п. Заголовки должны быть выровнены по левому краю. Вверху каждого заголовка должен быть пробел, равный двум кеглям данного заголовка, за исключением расположения заголовка вверху страницы. Внизу каждого заголовка должен быть пробел, равный кеглю данного заголовка |
| Графические элементы, используемые в заголовках | Не используются |
| Колонтитулы: | |
| - верхние | Содержат название главы и раздела. Название главы располагают со стороны переплета |
| - нижние | Содержат номер страницы со стороны, противоположной переплету, с указанием на противоположной стороне номера версии, даты ее выпуска и наименования документа |
| Гарнитуры шрифтов, кегли и расположение колонтитулов: | |
| - верхний | Times Roman, кегль 12 п, колонтитулы расположены вверху каждой страницы за исключением титульного листа |
| - нижний | Times Roman, кегль 12 п, номер страницы кегль 12 п, колонтитулы расположены внизу каждой страницы за исключением титульного листа |
| Графические элементы колонтитулов: | |
| - верхний | Должен быть подчеркнут линией толщиной в 1 п с вертикальным пробелом в 1 п |
| - нижний | Должен быть надчеркнут линией толщиной в 1 п с вертикальным интервалом в 1 п |
| Надпись | Начинается с номера рисунка с двоеточием и текстом, например «Рисунок 1:…» |
| Гарнитуры шрифта, кегль и расположение надписей | Times Roman italics, кегль 10 п. Надписи должны быть расположены под рисунком |
| Таблицы | Ширина таблиц должна соответствовать формату текста основной части документа, а для их обрамления используют линии толщиной в 1 п |
| Гарнитуры шрифтов и минимальные кегли для таблиц | Times Roman, минимальный кегль в 8 п |
| Отчеты (сообщения) | Должны содержать правдоподобные (но не фактические) данные |
| Гарнитуры шрифтов и минимальные кегли для отчетов | Courier, минимальный кегль в 8 п |
| Компоновка отчетов | Должны быть представлены в горизонтальной (альбомной) компоновке без использования страниц-раскладок |
| Распечатки экранов: | |
| - содержание | В каждом поле распечаток экранов должны быть представлены правдоподобные (но не фактические) данные |
| - оформление | Не должно быть горизонтальных или вертикальных искажений. Их ширина должна соответствовать формату набора |
| - частичные (т. е. представляющие часть экрана) | Должны быть в масштабе полноэкранных распечаток |
| Минимальная толщина линий, гарнитуры шрифтов и кегли для рисунков | 0,5 п, шрифт Times Roman, минимальный кегль в 8 п |