Кінець таблиці Н.1
|
Елемент |
Значення |
|
Гарнітура та мінімальний кегль написів |
Звіти повинні мати моноширинний шрифт Courier 8 пунктів |
|
Звіти: Застосовування альбомної орієнтації та сфальцьованих вклейок |
Звіти треба подавати у альбомній орієнтації; жодні сфальцьовані вклейки не застосовні |
|
Зміст дампів умісту екранів |
Дампи вмісту екранів повинні містити у кожному полі необхідні дані |
|
Макетування дампів вмісту екранів |
Дампи вмісту екранів не повинні перекручуватися по горизонталі або по вертикалі. Вони повинні мати таку саму ширину, що й поле друку |
|
Зміст дампів вмісту екранів для часткових дампів умісту екранів |
Часткові дампи вмісту екранів (тобто такі, що показують тільки частину екрана) повинні мати той самий масштаб, що й цілий екран |
|
Мінімальна товщина ліній, гарнітура та кегль ілюстрацій |
Мінімальна товщина лінії 0,5 пункту. Гарнітура: Times Roman. Кегль: мінімум 8 пунктів. |
|
Орієнтація ілюстрацій |
Орієнтація ілюстрацій та тексту всередині має збігатися з орієнтацією звичайного основного тексту документа |
|
Стиль тексту попередження та застереження |
Стиль речення, що починається зі слів «Попередження:» або «Застереження:» |
|
Гарнітура, кегль та інтервали попередження та застереження |
Times Roman, 24 пункти, напівгрубий, вирівняний по центру з інтервалом у два рядки зверху та знизу |
|
Зміст підказок |
Треба передбачити контекстну довідку, розгорнуту довідку, довідку щодо клавіатури, довідку щодо довідки, довідку щодо повідомлень та довідку щодо опорних фраз |
|
Зміст діалогової документації |
Діалогова документація повинна охоплювати настанову користувачеві, довідник команд, довідник повідомлень та інформацію для адміністратора |
|
Залежні матеріали |
По можливості, інформація стосовно однієї теми повинна займати один екран |
|
Підсвічування та застосовування кольору |
У діалоговій документації та підказках кольори не застосовні. Підсвічування (наприклад, більша інтенсивність) застосовно тільки для заголовків |
|
Макетування підказок та діалогової документації |
Між верхнім краєм відображення тексту (тобто рядком заголовка або верхнім краєм екрану) та першим рядком тексту має розміщуватися вільний рядок. Треба застосовувати одноколонковий формат |
|
Макетування заголовків підказок та діалогової документації |
Заголовки треба підсвічувати за рахунок більшої інтенсивності. Треба використовувати тільки два рівні заголовків. Заголовки повинні мати стиль речення (див. 8.2.3.7.2 Стиль тексту заголовків). Перед кожним заголовком та після нього треба розміщувати один вільний рядок |
|
Макетування основного тексту |
Текст має бути вирівняний по лівому краю, правий край нерівний, зліва від кожного рядку тексту має бути вільне місце, шириною 20 символів |
|
Правила навігації |
Рівні лінійної інформації треба контролювати так, щоб користувач міг вільно вернутися у задану точку, або до таблиці, змісту чи покажчика, не відчуваючи, що він загубився у документі |
|
Використовування клавіатури |
Треба використовувати такі клавіші: F1 для входу в довідкову систему; Alt-F4 або Esc для виходу з довідкової системи. Треба унеможливити для користувача втрату будь-яких даних, що вже було введено у разі вернення до екрану вводу даних після використовування довідкової системи |
Н.З Специфікація покажчика
Н.3.1 Загальні положення
Будь-який документ, що містить 32 сторінки або більше сторінок тексту, повинен мати покажчик.
Примітка. Всі частини документа треба проіндексувати, охоплюючи вступні матеріали, наступні матеріали, ілюстрації та додатки
Н.З.2 Якість
У покажчику має бути наведено достатньо подробиць, щоб задовольнити потреби передбачуваного кола користувачів.
Примітка. Покажчик повинен становити від 5 % загального обсягу документа (для навчальних настанов) до 10 % (для довідкових настанов). Треба розглянути можливість залучення професіонала з питань побудови покажчиків
Н.З.З Зміст та організація
Документація повинна мати єдиний покажчик, якщо інше не визначено планом документування.
Примітка 1. Заголовки (тобто слова або фрази, що подають у покажчику терміни або поняття у документі) треба переважно вибирати серед термінології’, наведеної в документі (наприклад, «програмне забезпечення комп’ютерів»).
Примітка 2. Однаковий термін має подавати одне й те саме поняття
Примітка 3. Підзаголовки, що подають деякі аспекти основного заголовка, часто можуть бути достатньо важливими, щоб застосовуватися як заголовки самі по собі.
Примітка 4. Основні заголовки мають подавати поняття, що містяться у документі. Перевагу слід віддавати іменникам, які, за потреби, модифікують за допомогою прикметників або інших іменників чи дієслів. У разі застосування в документі комп’ютерних команд, може бути прийнятним застосовувати наказову форму дієслів як основні заголовки.
Примітка 5. Терміни, що складаються більше ніж з одного слова, повинні використовуватись як заголовки без перетворення або розбивання їх на підзаголовки.
Примітка 6. Прийменників треба уникати, якщо тільки це не призводить до двозначності.
Примітка 7. Поняття, що являють собою різні аспекти того й самого об'єкта, треба перелічити як підзаголовки основного заголовка для об'єкта
Примітка 8. Скорочення та абревіатури має бути впорядковано згідно з абеткою та написанням.
Примітка 9. Елементи покажчика має бути впорядковано послівно; тобто пробіл треба розглядати як символ перед іншим символом.
Н.З.4 Посилання за місцеположенням
Для кожного елементу, що не є перехресним посиланням, має бути передбачено посилання за місцезнаходженням.
Посилання за місцезнаходженням треба робити або за номером сторінки (наприклад, «1, 2» або за номером абзацу чи розділу (наприклад, «2.22, 3.34»), Якщо ілюстрації проіндексовано, посилання за місцезнаходженням можна робити за номером ілюстрації.
Примітка 1. Загалом для користувачів зручніше посилання за номером сторінки, ніж за номером розділу.
Примітка 2. За елементами не повинні слідувати довгі рядки з посилань за місцеположенням. Прийнятний максимум дорівнює п'яти (наприклад, 1, 33, 43, 99, 102) Щоб уникнути довгих рядків із нерозділених посилань за місцезнаходженням, треба застосовувати підзаголовки.
Примітка 3. Посилання за місцезнаходженням на принципове обговорювання предмету може бути подано напівгру- бим шрифтом.
Примітка 4. Якщо перелік підзаголовків охоплює більше однієї колонки, заголовок треба повторювати зверху кожної додаткової’ колонки, за яким має йти слово «продовження»
Примітка 5. За наявності кількох послідовностей нумерування сторінок послідовності треба розділити у покажчику Наприклад, якщо нумерування починається знову в кожному розділі, у посилання за місцезнаходженням треба долучити номер розділу, наприклад «2.22, 3 34»
Примітка 6. У разі, якщо в документі розглядають предмет безперервно протягом частини послідовно пронумерованих послідовностей посилань, треба посилатися тільки на перший та останній нумерований елемент; елементи треба розділяти дефісом (умовно, коротким тире) (наприклад, «сторінки 3-11»), Якщо тире використовують під час нумерування сторінок, зазвичай тире не треба використовувати для розділення номерів сторінок, замість цього використовують слова «з» та «по» (наприклад, із 3-6 до 3-8).
Н.З.5 Перехресні посилання
Перехресні посилання типу «див.» (наприклад, дизайн — див. макет) треба робити для скорочень, синонімів та альтернативних форм, використовуваних у документі як форми, вибрані для заголовків покажчика.
Примітка. Крім того, перехресні посилання типу «див » треба застосовувати для інших форм, яких, скоріше всього, буде шукати користувач. За перехресними посиланнями типу «див.» ніколи не повинні йти посилання за місцезнаходженням
Перехресні посилання типу «див.» треба робити, починаючи з досконаліших форм до менш досконалих форм, якщо тільки це не призведе до того, що користувач буде направлений до ідентичного посилання за місцезнаходженням.Примітка. Перехресні посилання типу «див.» треба робити на зв'язувальні терміни, що мають інші взаємозалежності, якщо це допоможе користувачу покажчика. Перехресні посилання типу «див.» під заголовком треба збирати разом, як правило, за ними має бути посилання за місцезнаходженням, залежні від заголовка або підзаголовка, на який вони посилаються.
Наприклад:
ілюстрації 4
див. також графіка; дампи змісту екранів
індексування, 12
перелік, 15
нумерування, 2
написання для перекладання, 3, 15.
Терміни «див.» та «див. також», як правило, має бути виділено курсивом.
БІБЛІОГРАФІЯ
Наведені нижче публікації було вибрано тому, що вони наявні у більшості публічних бібліотек, а також тому, що вони містять ґрунтовну інформацію з певної тематики, що стосується цього стандарту. Жодні з цих публікацій не використовувалися як основа для написання цього стандарту. Хоча деякі розділи в цих публікаціях не збігаються із стандартом, вони являють собою корисне джерело інформації.
Споріднені національні та міжнародні стандарти
ISO 6592 Information technology — Guidelines for the documentation of computer-based application systems.
ISO 9127:1988 Information processing systems — User documentation and cover information for consumer software packages.
ISO/IEC 12119:1994 Information technology — Software packages — Quality requirements and testing.
ISO/IEC 12207:1995 Information technology — Software life cycle process.
BS 7649:1993 The design and preparation of documentation for users of application software.
Загальні публікації
Barnum С. M. and Carliner S. Techniques for Technical Communicators, MacMillan, 1993.
Brockmann, R. J. Writing Better Computer User Documentation. Wiley, 1990.
Brusaw С. T., Aired G. J. and Oliu W. E. Handbook of Technical Writing, St.’Martin’s Press, 1993.
Burnett R. E. Technical Communications, Wadsworth Publishing, 1994.
Hackos J. T. Managing Your Documentation Projects, Wiley, 1994.
Holtz H. The Complete Guide to Writing Readable User Manuals. Dow Jones-Irwin, 1988.
Horton W. K. Illustrating Computer Documentation. Wiley, 1991.
Simpson H. and Casey S. M. Developing Effective User Documentation: A Human Factors Approach. McGraw-Hill, 1988.
Weiss E. H. How to Write Usable User Documentation, Oryx Press, 1991.
Zinsser W. On Writing Well, Harper and Row, 1994.
Діалогова документація та гіпертекст
Bogan S., Farkas D. and Wellinske J. Developing On-Line Help for Windows, International Thomson Press, 1995.
Brown С. M. Human-Computer Interface Design. Norwood, 1988.
Helander (Ed). Handbook of Human-Computer Interaction. North Holland.
Horton W. K. Designing and Writing On-line Documentation. Help Text to Hypertext. Wiley, 1990.
Horton W. K. Designing and Writing On-line Documentation: Hypermedia for Self-Supporting Products, Wiley, 1994.
Laurel and Mountford The Art of Human-Computer Interface Design. Addison-Wesley, 1990.
Van der Veer and Mulder Human-Computer Interaction. Springer-Verlag, 1988.
Тестування на придатність
Dumas J. S. and Redish J. C. A Practical Guide to Usability Testing, Ablex Publishing, 1993.
Nielson J. Usability Engineering, AP Professional, 1993.НАЦІОНАЛЬНЕ ПОЯСНЕННЯ
Споріднені національні та міжнародні стандарти
ISO 6592 Інформаційні технології. Настанови щодо документування комп’ютерних програм.
ISO 9127:1988 Системи обробляння інформації. Документація користувача та інформація на обкладинках пакетів програмного забезпечення споживача.
З ISO/IEC 12119:1994 Інформаційні технології. Програмні пакети. Тестування і вимоги щодо якості.
ISO/IEC 12207:1995 Інформаційні технології. Процеси життєвого циклу програмного забезпечення.
BS 7649:1993 Розроблення та підготовлення документації для користувачів прикладного програмного забезпечення.
Загальні публікації
Барнум К. М. (Barnum С. М.) та Карлінер С. (Carliner S.) Методи технічної коммунікації, MacMillan,.--1993.
Брокман Р. Д. (Brockmann, R. J.) Написання кращої документації для користувачів комп’ютерів. Wiley, 1990.
Брусау К. Т. (Brusaw С. Т)., Елред Дж.Дж. (Aired G. J.) та Олью В.Е. (Oliu W. Е.) Довідник із написання технічних текстів, St. Martin's Press, 1993.
Барнет R Е. (Burnett R. E.) Технічна комунікація, Wadsworth Publishing, 1994.
Хекос Дж. T. (Hackos J. T.) Керування вашими проектами документування, Wiley, 1994.
Хольтц Г. (Holtz H.) Повна настанова щодо написання придатних для читання настанов для користувача. Dow Jones-Irwin, 1988.
Хортон В. К. (Horton W. К.) Ілюстрування комп’ютерної документації. Wiley, 1991.
Сімпсон Г. (Simpson Н.) та Кайзі С. М. (Casey S. М.) Розробляння ефективної документації для користувачів: Підхід на основі людського чинника. McGraw-Hill, 1988.
Вайсс Е. Г. (Weiss Е. Н.) Як писати придатну документацію для користувачів, Oryx Press, 1991.
Цінссер В. (Zinsser W.) Про те, як писати добре, Harper and Row, 1994.
Діалогова документація та гіпертекст
Боган С. (Bogan S.), Фаркас Д. (Farkas D.) та Веллінске Дж. (Wellinske J.) Розроблення діалогової довідкової системи для Windows, International Thomson Press, 1995.
Броун К. М. (Brown, С. М.) Розроблення інтерфейсу «людина-комп’ютер». Norwood, 1988.
Хеландер (ред.) (Helander) Настанова щодо взаємодії «людина-комп’ютер». North Holland.
Нортон В. К. (Horton W. К.) Розроблення та написання діалогової документації: Від підказки до гіпертексту. Wiley, 1990.
Нортон В. К. (Horton W. К.) Розроблення та написання діалогової документації: Гіперсередовище для продуктів самопідтримкою, Wiley, 1994.
Лаурел та Моунтфорд (Laurel and Mountford) Мистецтво розроблення інтерфейсу «людина-комп’ютер». Addison-Wesley, 1990.
Ван дер Веер та Малдер (Van der Veer and Mulder) Взаємодія «людина-комп’ютер». Springer-Verlag, 1988.
