Информационная технология. Процесс создания документации пользователя программного средства - [18]
В целом план документирования должен учитывать все специфические обстоятельства, относящиеся к организации-заказчику и пользователям. Крайне маловероятна возможность использования плана документирования, разработанного в рамках одного проекта, для другого.
ПРИЛОЖЕНИЕ Н (справочное)
Образец спецификации стиля
Н.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 п, колонтитулы расположены внизу каждой страницы за исключением титульного листа |
Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО/МЭК 12119-94 «Информационная технология. Пакеты программ. Требования к качеству и тестирование»ГОСУДАРСТВЕННЫЙ СТАНДАРТ РОССИЙСКОЙ ФЕДЕРАЦИИГОСТ Р ИСО/МЭК 12119-2000Information technology. Software packages. Quality requirements and testing.
В книге рассказывается история главного героя, который сталкивается с различными проблемами и препятствиями на протяжении всего своего путешествия. По пути он встречает множество второстепенных персонажей, которые играют важные роли в истории. Благодаря опыту главного героя книга исследует такие темы, как любовь, потеря, надежда и стойкость. По мере того, как главный герой преодолевает свои трудности, он усваивает ценные уроки жизни и растет как личность.
В книге рассказывается история главного героя, который сталкивается с различными проблемами и препятствиями на протяжении всего своего путешествия. По пути он встречает множество второстепенных персонажей, которые играют важные роли в истории. Благодаря опыту главного героя книга исследует такие темы, как любовь, потеря, надежда и стойкость. По мере того, как главный герой преодолевает свои трудности, он усваивает ценные уроки жизни и растет как личность.
Настоящий стандарт представляет собой полный аутентичный текст международного стандарта ИСО/МЭК 17025-99 «Общие требования к компетентности испытательных и калибровочных лабораторий»Настоящий стандарт является результатом большого опыта внедрения Руководства ИСО/МЭК 25 и ЕН 45001, взамен которых он теперь действует. В нем содержатся все требования, которым испытательные и калибровочные лаборатории должны соответствовать, если они намерены показать, что у них действует система качества, что они технически компетентны и способны получать технически обоснованные результаты.Органам по аккредитации, признающим компетентность испытательных и калибровочных лабораторий, следует основывать свою деятельность на настоящем стандарте.
В книге рассказывается история главного героя, который сталкивается с различными проблемами и препятствиями на протяжении всего своего путешествия. По пути он встречает множество второстепенных персонажей, которые играют важные роли в истории. Благодаря опыту главного героя книга исследует такие темы, как любовь, потеря, надежда и стойкость. По мере того, как главный герой преодолевает свои трудности, он усваивает ценные уроки жизни и растет как личность.
Embedded system software. General requirements for development and documentationСтандарт подготовлен в развитие ГОСТ Р ИСО/МЭК 12207-99 «Информационная технология. Процессы жизненного цикла программных средств» с целью учета специфики разработки и документирования программного обеспечения встроенных систем реального времени.
Статья, дающая смелый прогноз развития электротехники, транспорта, энергетики на 70 лет вперед. Напечатана 15 февраля 1927 года в газете "Харьковский пролетарий". Перевод с французского.
Что такое время? Странный вопрос. Ведь это каждый знает. Все только и говорят о нем. «Катастрофически не хватает времени», — жалуются одни. «Как медленно течет время», — говорят другие, когда приходится чего-то или кого-то ждать. То и дело можно слышать вопрос: «Который час?» или (что не очень правильно) «Сколько сейчас времени?»А между тем еще в древности один философ сказал: «Я прекрасно знаю, что такое время, пока не задумываюсь об этом. Но стоит мне задуматься, и я не могу ответить».С тех пор как были сказаны эти слова, прошло много лет, но до сих пор далеко не все тайны времени разгаданы.
В книге рассмотрены последние достижения физики и их применения в ряде отраслей современного производства, приборостроения, в электронике, связи, транспорте и медицине. Изложены физические основы мембранной технологии, перспективы использования солитонов и другие вопросы. Книга предназначена для дополнительного чтения по физике в средних специальных учебных заведениях. Может быть полезна учителям физики и учащимся школ и профтехучилищ.
Очерк преподавателя Военно-морской академии Алексея Травиничева, в котором сравнивается "Наутилус" Жюля Верна с реальными подводными судами начала ХХ века. Помимо оценки эффективности действия подводных лодок в реальных боевых ситуациях и тактико-технических характеристик новейших субмарин, оценивается их возможное применение для научно-исследовательской работы в океане…
Умение работать с благородным материалом – деревом – всегда высоко ценилось в России. Но приобретение умений и навыков мастера плотничных и столярных работ невозможно без правильного подхода к выбору материалов, инструментов, организации рабочего места, изучения технологических тонкостей, составляющих процесс обработки древесины. Эта книга покажет возможности использования этих навыков как в процессе строительства деревянного дома, так и при изготовлении мебели своими руками, поможет достичь определенных высот в этом увлекательном и полезном процессе.
Настоящий Федеральный закон принимается в целях защиты жизни, здоровья, имущества граждан и юридических лиц, государственного и муниципального имущества от пожаров, определяет основные положения технического регулирования в области пожарной безопасности и устанавливает общие требования пожарной безопасности к объектам защиты (продукции), в том числе к зданиям, сооружениям и строениям, промышленным объектам, пожарно-технической продукции и продукции общего назначения. Федеральные законы о технических регламентах, содержащие требования пожарной безопасности к конкретной продукции, не действуют в части, устанавливающей более низкие, чем установленные настоящим Федеральным законом, требования пожарной безопасности.Положения настоящего Федерального закона об обеспечении пожарной безопасности объектов защиты обязательны для исполнения: при проектировании, строительстве, капитальном ремонте, реконструкции, техническом перевооружении, изменении функционального назначения, техническом обслуживании, эксплуатации и утилизации объектов защиты; разработке, принятии, применении и исполнении федеральных законов о технических регламентах, содержащих требования пожарной безопасности, а также нормативных документов по пожарной безопасности; разработке технической документации на объекты защиты.Со дня вступления в силу настоящего Федерального закона до дня вступления в силу соответствующих технических регламентов требования к объектам защиты (продукции), процессам производства, эксплуатации, хранения, транспортирования, реализации и утилизации (вывода из эксплуатации), установленные нормативными правовыми актами Российской Федерации и нормативными документами федеральных органов исполнительной власти, подлежат обязательному исполнению в части, не противоречащей требованиям настоящего Федерального закона.
Стандарт подготовлен на основе применения аутентичного текста международного стандарта ИСО/МЭК 9126-91 «Информационная технология. Оценка программной продукции. Характеристики качества и руководства по их применению»Information technology. Software product evaluation. Quality characteristics and guidelines for their use.
Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО/МЭК 8631-89 «Информационная технология. Программные конструктивы и условные обозначения для их представления».