Для дуже великих проектів елементи постачання мають бути розділені на контрольовані частини. Після цього можна отримати оцінку часу для завершення проекту в цілому тільки з точністю до місяця, причому деталізовано може бути лише першу частину плану. Таким чином, як постачальник документації, так і замовник мають змогу уточнити оцінку дати постачання.
У таблиці F.1 наведено часові оцінки для «типового» проекту; враховуючи, що автор документації набирає матеріал безпосередньо на персональному комп’ютері із застосовування настільної видавничої системи.
Таблиця F.1 — Часові оцінки
|
Етап |
Час |
|
Визначання елементів постачання |
16 год на проект |
|
Досліджування змісту |
24 год на проект |
|
Написання плану документування |
48 год на проект |
|
Проектування структури документа/макета сторінки |
8 год на том |
|
Написання першої попередньої версії |
1 год на сторінку |
|
Розроблення графіки |
5 год на графічний елемент |
|
Об’єднання тексту та графіки |
ЗО хв на сторінку |
|
Переглядання першої попередньої версії на предмет технічної точності (замовник) |
ЗО хв на сторінку |
|
Удосконалювання попередньої версії та графіки |
ЗО хв на сторінку |
|
Внесення зауваг користувачів |
ЗО хв на сторінку |
|
Редагування граматики |
15 хв на сторінку |
|
Підготовлення другої попередньої версії |
15 хв на сторінку |
|
Переглядання другої попередньої версії (постачальник документації) |
15 хв на сторінку |
|
Внесення завершальних змін |
10 хв на сторінку |
|
Тестування документації |
15 хв на сторінку |
|
Виготовляння оригінал-макета |
3 дні роботи |
|
Друк переплетення/вкладок |
5 днів роботи |
|
Друк та брошурування копій (тільки чорно-білий друк) |
10 днів роботи |
|
Розподілення |
1 день роботи |
F.3 Підхід згори-донизу
F.3.1 Загальні положення
Цей метод базується на передумові, що кількість сторінок у публікації або публікаціях може бути легко оцінено, і у ньому використано такі припущення:
Автор може підготувати 22 сторінки нового тексту за місяць.
Автор може підготувати 44 сторінки зміненого тексту за місяць.
Наприклад, публікацію може бути оцінено в 150 сторінок. За умови, що це нова публікація, для її завершення знадобиться 150/22 = 7 людино/місяців. Ці 7 місяців охоплюють планування публікації, написання, редагування та переглядання двох попередніх версій та підготовлення копії оригінал-макета.
F.3.2 Пропорції
Ці 7 людино/місяців розподіляють пропорційно так:
15 % на планування (у нашому прикладі 4 тижні).
50 % на першу попередню версію (14 тижнів).
25 % на другу попередню версію (14 тижнів).
10 % на копію оригінал-макета (3 тижні).
F.3.3 Планування
Період планування охоплює таке:
Досліджування та написання плану.
Перевіряння та переглядання плану.
Коригування плану в результаті перегляду.
3.4 Перша попередня версія
Перша попередня версія охоплює таке:
Підготовлення таблиці змісту.
Перевіряння та переглядання таблиці змісту.
Написання тестової частини для редактора.
Редагування тестової частини та її переписування відповідно до результатів редагування.
Написання першої попередньої версії повністю.
Редагування завершеної першої попередньої версії.
д) Перероблення відредагованої першої попередньої версії.
h) Перевіряння та переглядання переробленої попередньої версії.
F.3.5 Друга попередня версія
Друга попередня версія охоплює таке:
Впроваджування всіх зауважень після переглядання для першої попередньої версії.
Редагування копії завершеної попередньої версії.
Перероблення відредагованої попередньої версії.
Перевіряння та переглядання переробленої попередньої версії.
F.3.6 Узгоджена попередня версія
Узгодженою попередньою версією є оригінал-макет, який охоплює таке:
Впроваджування всіх зауважень після переглядання другої попередньої версії.
Перевіряння факту внесення всіх потрібних змін.
Видаляння всіх чорнових позначок на зразок редакторських рисок та класифікацій захисту.
Підготовлення оригінал-макетів.
Направлення оригіналів на друкувальний пристрій.
Як правило, учасникам переглядання треба від одного до двох тижнів для перевіряння попередньої версії та підготовлення зауваг, саме ж переглядання потребує від одного до кількох днів.
Підхід згори-донизу також можна використовувати для наявних публікацій. Наприклад, книга обсягом 100 сторінок може бути перероблена таким чином, що у половину книги вносять зміни, і до неї долучають новий матеріал, що становить 10 % від загального обсягу. Внесення змін до наявного матеріалу потребує 50/44 = 1,13 людино/місяців, а внесення нового матеріалу потребує 10/22 = 0,45 людино/місяців.
У випадках, коли тривалість роботи перевищує допустимий час, для виконання роботи залучають більше одного спеціаліста з документування. Це також зазвичай трапляється, коли для одного й того самого програмного забезпечення треба підготувати декілька публікацій.ДОДАТОК G
(довідковий)
ОЦІНЮВАННЯ ПЛАНУ ДОКУМЕНТУВАННЯ
Застосування цього стандарту може сприяти виготовлянню якісної документації тому, що план документування має бути узгоджено між замовником та постачальником документації. Це застосування має два головних наслідки: воно гарантує, що постачальник документації щонайменше врахує всі аспекти документації, долучені до плану, та воно гарантує, що замовник та постачальник документації узгодили підхід до документування, встановлений планом, в ідеальному випадку — до початку роботи.
Замовник повинен розраховувати на те, що він віднайде у плані документування такі елементи: а) Всі кола користувачів повинні бути належним чином визначені. Твердження на зразок: «Коло користувачів цієї настанови складатимуть користувачі програмного забезпечення» не є достатнім. (Дивись додаток Д). Всі люди, які можуть використовувати програмне забезпечення (охоплюючи тих, які можуть користуватися звітами, що воно генерує) повинні бути долучені до визначення кола користувачів.
Має бути включено деталізовану таблицю змісту разом з оцінкою підрахунку сторінок.
Має бути визначено кількість друкованих копій та метод друкування і переплетення.
Має бути чітко визначено власника авторських прав на матеріал.
Має бути визначено метод продукування. В цей час більшість спеціалістів з технічної документації під час написання документів використовує комп’ютер.
Постачальник документації повинен дати замовникові достатньо часу для переглядання попередніх версій — будь-яке затримування повернення попередніх версій постачальнику документації ймовірно може призвести до затримок у постачанні.
д) Може виникнути потреба у наданні ресурсів із боку організації-замовника (доступ до персоналу, обладнання тощо), а збої щодо цього можуть призвести до затримок.
Загалом у плані документування треба врахувати всі специфічні умови, в яких працює компанія замовника та користувачі. Дуже малоймовірно, що план, розроблений для одного проекту, може бути ефективно застосований для іншого.
ДОДАТОК Н
(довідковий)
ПРИКЛАД СПЕЦИФІКАЦІЇ СТИЛЮ
Н.1 Загальні положення
Приклад специфікації стилю відповідає вимогам, наведеним у 8.2 цього стандарту, і його може бути використано в плані документування за промовчанням.
Примітка. Корисно перед тим, як створити модель документа зі специфікації стилю, доречно завершити операцію стилю.
Н.2 Елементи стилю
Елементи стилю та передбачувані значення за промовчанням наведено у таблиці Н.1.
Таблиця Н.1 — Елементи стилю та значення
|
Елемент |
Значення |
|
Мова |
Українська |
|
Орфографічний словник та винятки |
Орфографічний словник української мови видавництва «Наукова думка», без винятків |
|
Настанова з граматики та стилю застосовування |
Українське документування; мова та стиль. Настанова |
|
Розмір паперу |
А4 |
Продовження таблиці Н 1
|
Елемент |
Значення |
|
Орієнтація |
Портретна (тобто вертикальна пряма) |
|
Двосторонній або односторонній друк |
Двосторонній |
|
Розподільна здатність набору або лазерного друку |
300 точок на дюйм як мінімум |
|
Ширина внутрішніх берегів |
10 мм/2,4 цицеро |
|
Ширина зовнішніх берегів |
10 мм/2,4 цицеро |
|
Кольори чорнил |
Чорні |
|
Колір, вага та якість паперу |
80 г/м2 білий високоякісний |
|
Роздільники |
Немає |
|
Переплетення |
Пластикова скоба з прозорою передньою обкладинкою та задньою картонною обкладинкою (картон від 200 г/м2 до 260 г/м2) |
|
Метод репродукування та якість |
Весь матеріал має бути сфотокопійовано і він має бути вільним від позначок та знебарвлення |
|
Схема нумерування сторінок |
Сторінки треба нумерувати числами 1, 2, 3 і т д , починаючи з першої сторінки після обкладинки |
|
Нумерування ілюстрацій та таблиць ілюстрації має бути |
Ілюстрації треба нумерувати «Рисунок 1», «Рисунок 2» і т д у порядку’їх слідування Таблиці треба нумерувати «Таблиця 1», «Таблиця 2» і т д у порядку їх слідування |
|
Кількість колонок |
Одна |
|
Застосування виносок та кінцевих виносок |
Виноски та кінцеві виноски не застосовують |
|
Правила верстання |
Заголовки не треба розташовувати у кінці сторінки Таблиці не повинні переходити з однієї сторінки на іншу, за винятком випадку, коли ’їх довжина перевищує одну сторінку Всі заголовки 1-го рівня треба розташувати у горизонтальній частині правої сторінки |
|
Правила заповнювання |
Залежні матеріали мають знаходитись на тій самій сторінці або на протилежній сторінці По можливості, треба уникати застосування підкреслення, великих обсягів напівгрубого шрифту та заголовних літер Треба використовувати від 40 % до 60 % активного вільного простору |
|
Титульні та кінцеві матеріали титульна сторінка |
Титульна сторінка призначена для відображення назви продукту, версії продукту, дати випуску документа та назви тому |
|
Титульні та кінцеві матеріали гарантійні зобов’язання, інформація щодо авторських прав та торгової марки |
Не передбачено |
|
Титульні та кінцеві матеріали таблиця змісту |
Таблиця змісту призначена для відображення заголовків усіх частин, глав та розділів із номерами сторінок |
|
Титульні та кінцеві матеріали перелік ілюстрацій та таблиць |
Не передбачено |
|
Титульні та кінцеві матеріали додатки |
Не передбачено |
|
Титульні та кінцеві матеріали глосарії |
Будь-який термін, використовуваний у томі, що незнайомий передбачуваному колу користувачів, має бути визначено у глосарії за допомогою термінів, знайомих цільовому колу користувачів |
|
Титульні та кінцеві матеріали перелік абревіатур та скорочень |
Для відображення кожної абревіатури застосовно список абревіатур разом із текстом, що утворює цю абревіатуру У випадках, коли текст не є самоочевидним для цільового кола користувачів, треба також передбачити пояснення |
Продовження таблиці Н.1
|
Елемент |
Значення |
|
Титульні та кінцеві матеріали: покажчик |
Треба долучити покажчик із визначеним змістом (Н.З) |
|
Титульні та кінцеві матеріали: порядок слідування елементів |
Титульні та кінцеві матеріали треба розмістити у порядку, в якому вони наведені у цій таблиці, причому основний текст документа розміщують між таблицею змісту та глосарієм |
|
Гарнітура та кегль основного тексту |
Шрифт Times Roman, 12 пунктів |
|
Відступи та інтервали основного тексту |
Основний текст повинен мати спереду відступ 2 пункти, а також відступ зліва ЗО мм/7цицеро. Між абзацами основного тексту має бути встановлено інтервал, рівний одному рядку |
|
Вирівнювання основного тексту |
Основний текст треба вирівнювати по лівому краю, правий край нерівний |
|
Кількість та назви рівнів заголовків |
Чотири — заголовок частини, заголовок глави, заголовок розділу та заголовок підрозділу |
|
Стиль тексту заголовків |
Усі заголовки має бути наведено реченням з першою заголовною буквою на початку кожного заголовка та без знаків пунктуації в кінці заголовка |
|
Гарнітура, кегль та інтервали кожного з рівнів заголовків |
Усі заголовки має бути виконано напівгрубим шрифтом Times Roman із застосовуванням таких розмірів шрифту: заголовок частини — 36 пунктів, заголовок глави — 24 пункти, заголовок розділу — 18 пунктів, заголовок підрозділу — 14 пунктів. Заголовки треба повністю вирівнювати по лівому краю. Вище кожного заголовка має бути передбачено вільне місце розміром, вдвічі більшим ніж кегль, яким набрано заголовок, за винятком випадку, коли заголовок припадає на початок сторінки. Нижче кожного заголовку має бути передбачено вільне місце розміром, що дорівнює розміру кегля, яким набрано заголовок |
|
Графічні елементи, застосовувані у заголовках |
Не передбачено |
|
Зміст верхніх колонтитулів |
Верхні колонтитули мають відображати заголовки глави та розділу, у цьому разі заголовок глави розміщують з боку, ближчого до переплетення |
|
Зміст нижніх колонтитулів |
Нижні колонтитули мають відображати номер сторінки з боку, дальшого від переплетення, у цьому разі з іншого боку відображають номер версії, дату версії та назву документа |
|
Гарнітура, кегль та розміщування верхніх колонтитулів |
Шрифт Times Roman, 12 пунктів зверху кожної сторінки, за винятком титульної |
|
Гарнітура, кегль та розміщування нижніх колонтитулів |
Шрифт Times Roman, 12 пунктів знизу кожної сторінки, за винятком титульної, у цьому разі номер сторінки має шрифт Times Roman, 12 пунктів, напівгрубий |
|
Графічні елементи для верхніх колонтитулів |
Зверху кожного заголовка треба розмістити лінію, товщиною 1 пункт на відстані 1 пункт |
|
Графічні елементи для нижніх колонтитулів |
Знизу кожного заголовка треба розмістити лінію, товщиною 1 пункт на відстані 1 пункт |
|
Зміст написів |
Кожна назва повинна починатися з номера рисунка, за якою йде двокрапка, за якою йде текст назви, наприклад, «Рисунок 1:...» |
|
Гарнітура, кегль та розміщування написів |
Назви треба розміщувати над рисунками. Назви повинні мати шрифт Times Roman, 10 пунктів, курсив |
|
Правила макетування таблиць |
Таблиці повинні мати таку саму ширину, що й поле основного тексту і використовувати лінії тільки товщиною в 1 пункт |
|
Гарнітура та мінімальний кегль таблиць |
Times Roman з мінімальним кеглем у 8 пунктів |
|
Зміст звітів |
Звіти повинні містити необхідні дані |
