Информационная технология. Процесс создания документации пользователя программного средства - [15]
Например, информационные потребности данной аудитории в рамках конкретного задания могут быть удовлетворены в формате печатного руководства, диалогового руководства, контекстно-зависимых справочных экранов, справочных схем или видео- и оперативных руководств.
Обычно стремятся сократить номенклатуру разрабатываемых документов. При этом стараются один документ использовать в разных целях.
На рисунке D.4 показаны виды деятельности (работы), выполняемые в процессе проектирования документации. Одним из важных моментов является представление пользователю необходимых сведений на различных носителях; потребность в этом не предопределяется ролью диалоговой или бумажной документации; ролью любого носителя является представление пользователю необходимых сведений в требуемом виде (формате) в зависимости от конкретной аудитории, продукта и набора заданий пользователя. Планирование документации (в соответствии с настоящим стандартом) связано только с установлением набора сведений, необходимых пользователям, и лишь в конце процесса документирования решается вопрос о выборе носителя, на котором следует представлять эти сведения. Например, диалоговую и бумажную документацию следует планировать одновременно, так как одному пользователю для получения необходимых сведений может потребоваться документация обоих видов.
Рисунок D.4 — Общая структура процесса проектирования документирования
Более подробное описание процесса проектирования документации приведено в BS 7649-93 [2].
ПРИЛОЖЕНИЕ Е (справочное)
Рекомендации по написанию на английском языке документации, подлежащей последующему переводу
Е.1 Общие положения
В настоящем приложении приведены рекомендации, которые следует учитывать при написании на английском языке исходных материалов, подлежащих последующему переводу на другие языки. Большая часть данных рекомендаций относится как к бумажной, так и диалоговой документации.
Е.2 Терминология
В части терминологии, используемой в документах, необходимо руководствоваться следующими правилами:
a) применять общие и нетехнические термины в соответствии с их определениями, установленными в общих словарях;
b) создавать глоссарии (словники), содержащие:
1) определения всех специфических и неизвестных терминов,
2) виды и определения всех обозначений и сокращений,
3) толкования непривычного использования слов, применение имен существительных в качестве наречий,
4) библиографию специализированных словарей и стандартов;
c) специальная терминология должна быть основана на национальных или международных терминологических стандартах, общепризнанных словарях или согласованных глоссариях;
d) каждое сокращение должно быть расшифровано при первом его появлении в тексте основной части документа;
e) каждый термин должен одинаково трактоваться в документе, диалоговой информации и системной библиотеке;
f) составные выражения (например, «ввод данных [data input]») должны иметь одно смысловое значение во всей документации;
g) составные выражения не должны содержать более трех слов;
h) одно и то же слово не должно использоваться для различных частей речи;
i) все специфические и специальные термины должны использоваться в соответствующем контексте;
j) термины, вводимые вне соответствующего контекста, например наименования клавиш или команды, должны быть определены в глоссарии;
k) следует избегать использования термина «биллион (billion)».
Примечание — Американский биллион (10>9) не совпадает с английским биллионом (10>12);
1) следует избегать использования термина «перевод (translation)», например при ссылке на перевод в формат файла, в смысловом значении, отличном от перевода с одного языка на другой. Вместо этого следует применять термин «преобразование (conversion)».
Е.3 Стиль перевода
Е.3.1 Обозначения
Следует использовать только общепринятые обозначения, которые должны быть расшифрованы в списке обозначений. Не должны применяться следующие обозначения:
a) американский символ «#» для фунта;
b) приподнятая точка () для операции умножения.
Е.3.2 Неоднозначно трактуемые слова
Авторы документов должны избегать использования следующих неоднозначно трактуемых слов:
а) who (кто), that (который), which (какой);
b) only (только), merely (приблизительно), just (едва), mainly (в основном), simply (просто);
с) while (пока);
d) so (таким образом);
e) as (как);
f) can (иметь возможность), may (мочь);
g) since (так как);
h) when (когда), if (если);
i) alternate (дополнительный), alternative (альтернативный).
Е.3.3 Синтаксис
Должны быть учтены следующие вопросы синтаксиса:
a) предложения не должны быть слишком длинными;
b) следует избегать построения предложений, описывающих ряд положений, разделяемых чрезмерным количеством запятых;
c) пункты, содержащие определенные ограничения, и пункты без ограничений должны быть представлены раздельно.
Е.3.4 Пунктуация
Там, где могут быть использованы скобки или точка с запятой, не следует применять тире.
Е.4 Физические факторы
Необходимо учитывать следующие физические факторы:
a) сокращения нецелесообразно использовать только для экономии места;
b) предусмотреть необходимые места для простановки соответствующих значений, например цены;
Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО/МЭК 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 «Информационная технология. Процессы жизненного цикла программных средств» с целью учета специфики разработки и документирования программного обеспечения встроенных систем реального времени.
Вниманию читателей предлагается книга, посвященная созданию первого поколения отечественных обитаемых подводных аппаратов, предназначенных для работы на глубинах более 1000 м История подводного флота, несмотря на вал публикации последнего времени, остается мало известной не только широкой общественности, но и людям, всю жизнь проработавшим в отрасли Между тем. сложность задач, стоящих перед участниками работ по «глубоководной тематике» – так это называлось в Министерстве судостроительной промышленности – можно сравнить только с теми, что пришлось решать создателям космических кораблей Но если фамилии Королева и Гагарина известны всему миру, го о главном конструкторе глубоководной техники Юрии Константиновиче Сапожкове или первом капитане-глубоководнике Михаиле Николаевиче Диомидове читатель впервые узнает из этой книги.
Рассмотрены основные металлические материалы, которые применяются в ювелирной технике, их структура и свойства. Подробно изложены литейные свойства сплавов и приведены особенности плавки драгоценных металлов и сплавов. Описаны драгоценные, полудрагоценные и поделочные камни, используемые в ювелирном деле. Приведены примеры уникальных ювелирных изделий, изготовленных мастерами XVI—XVII веков и изделия современных российских мастеров.Книга будет полезна преподавателям, бакалаврам, магистрам и аспирантам, а так же учащимся колледжей и читателям, которые желают выбрать материал для изготовления ювелирных изделий в небольших частных мастерских.Рекомендовано Министерством образования и науки Российской Федерации в качестве учебника для бакалавров, магистров по специальности 26140002 «Технология художественной обработки материалов» и аспирантов специальности 170006 «Техническая эстетика и дизайн».
Автомобиль – это источник повышенной опасности, поэтому управлять им могут только люди, прошедшие специальное обучение, имеющие медицинскую справку, стажировку.Книга посвящена вопросу охраны труда. В ней подробно изложены общие положения, которыми должны руководствоваться наниматели, внеплановые и текущие инструктажи для водителей, а также другие немаловажные моменты, обеспечивающие безопасность водителя.Отдельно рассмотрены дорожно-транспортные происшествия и их причины, исходные данные для проведения автотранспортной экспертизы, модели поведения в случаях попадания в ДТП, приближения к месту аварии, а также общий порядок оказания помощи и порядок оформления несчастных случаев.Кроме того, в книге можно найти информацию по правилам перевозки негабаритных и опасных грузов, а также системе информации об опасности (СИО).
Умение работать с благородным материалом – деревом – всегда высоко ценилось в России. Но приобретение умений и навыков мастера плотничных и столярных работ невозможно без правильного подхода к выбору материалов, инструментов, организации рабочего места, изучения технологических тонкостей, составляющих процесс обработки древесины. Эта книга покажет возможности использования этих навыков как в процессе строительства деревянного дома, так и при изготовлении мебели своими руками, поможет достичь определенных высот в этом увлекательном и полезном процессе.
Настоящий Федеральный закон принимается в целях защиты жизни, здоровья, имущества граждан и юридических лиц, государственного и муниципального имущества от пожаров, определяет основные положения технического регулирования в области пожарной безопасности и устанавливает общие требования пожарной безопасности к объектам защиты (продукции), в том числе к зданиям, сооружениям и строениям, промышленным объектам, пожарно-технической продукции и продукции общего назначения. Федеральные законы о технических регламентах, содержащие требования пожарной безопасности к конкретной продукции, не действуют в части, устанавливающей более низкие, чем установленные настоящим Федеральным законом, требования пожарной безопасности.Положения настоящего Федерального закона об обеспечении пожарной безопасности объектов защиты обязательны для исполнения: при проектировании, строительстве, капитальном ремонте, реконструкции, техническом перевооружении, изменении функционального назначения, техническом обслуживании, эксплуатации и утилизации объектов защиты; разработке, принятии, применении и исполнении федеральных законов о технических регламентах, содержащих требования пожарной безопасности, а также нормативных документов по пожарной безопасности; разработке технической документации на объекты защиты.Со дня вступления в силу настоящего Федерального закона до дня вступления в силу соответствующих технических регламентов требования к объектам защиты (продукции), процессам производства, эксплуатации, хранения, транспортирования, реализации и утилизации (вывода из эксплуатации), установленные нормативными правовыми актами Российской Федерации и нормативными документами федеральных органов исполнительной власти, подлежат обязательному исполнению в части, не противоречащей требованиям настоящего Федерального закона.
Стандарт подготовлен на основе применения аутентичного текста международного стандарта ИСО/МЭК 9126-91 «Информационная технология. Оценка программной продукции. Характеристики качества и руководства по их применению»Information technology. Software product evaluation. Quality characteristics and guidelines for their use.
Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО/МЭК 8631-89 «Информационная технология. Программные конструктивы и условные обозначения для их представления».