ПРИЛОЖЕНИЕ D (справочное) Отношения между аудиториями, выданными заданиями, бумажной и диалоговой документацией
ПРИЛОЖЕНИЕ D (справочное)
Отношения между аудиториями, выданными заданиями, бумажной и диалоговой документацией
Проектирование документации начинается с анализа пользователей документируемой системы. Как правило, существуют определенные группы пользователей, объединяемые в определенные аудитории в соответствии с их потребностями.
Рисунок D.1 — Иерархия аудиторий
В ряде случаев иерархию аудиторий целесообразно представлять в виде отдельных групп, как показано на рисунке D.1.
В ряде случаев следует выбирать аудиторию, исходя из опытности пользователя данной аудитории по использованию системы. Например, аудитории могут быть определены как «Неопытные пользователи» или «Опытные пользователи».
После определения перечня аудиторий для конкретной системы на следующем этапе следует определить задания (tasks), выполняемые каждой аудиторией. Часто данные задания представляют в виде иерархической структуры (см. рисунок D.2).
Рисунок D.2 — Иерархия заданий
На следующем этапе для определенной аудитории в рамках выданных ей заданий определяют перечень ее потребностей в информации (information needs). На основе данного перечня определяют содержание конкретного документа, как показано на рисунке 3.
Рисунок D.3 — Информационные потребности
На данном этапе (но не ранее) следует определить вид (тип) конкретного документа и машинный носитель, на котором он поставляется.
Например, информационные потребности данной аудитории в рамках конкретного задания могут быть удовлетворены в формате печатного руководства, диалогового руководства, контекстно-зависимых справочных экранов, справочных схем или видео- и оперативных руководств.
Обычно стремятся сократить номенклатуру разрабатываемых документов. При этом стараются один документ использовать в разных целях.
На рисунке D.4 показаны виды деятельности (работы), выполняемые в процессе проектирования документации. Одним из важных моментов является представление пользователю необходимых сведений на различных носителях; потребность в этом не предопределяется ролью диалоговой или бумажной документации; ролью любого носителя является представление пользователю необходимых сведений в требуемом виде (формате) в зависимости от конкретной аудитории, продукта и набора заданий пользователя. Планирование документации (в соответствии с настоящим стандартом) связано только с установлением набора сведений, необходимых пользователям, и лишь в конце процесса документирования решается вопрос о выборе носителя, на котором следует представлять эти сведения. Например, диалоговую и бумажную документацию следует планировать одновременно, так как одному пользователю для получения необходимых сведений может потребоваться документация обоих видов.
Рисунок D.4 — Общая структура процесса проектирования документирования
Более подробное описание процесса проектирования документации приведено в BS 7649-93 [2].
Более 800 000 книг и аудиокниг! 📚
Получи 2 месяца Литрес Подписки в подарок и наслаждайся неограниченным чтением
ПОЛУЧИТЬ ПОДАРОКЧитайте также
ПРИЛОЖЕНИЕ В (справочное) Руководство по адаптации
ПРИЛОЖЕНИЕ В (справочное) Руководство по адаптации Не существует двух одинаковых проектов. Варианты организационных подходов и процедур, методов и политики заказа, размеров и сложности проекта, требований к системе и методов разработки в том числе влияют на то, как
ПРИЛОЖЕНИЕ С (справочное) Руководство по процессам и организациям
ПРИЛОЖЕНИЕ С (справочное) Руководство по процессам и организациям В настоящем приложении с целью лучшего понимания текста стандарта обсуждаются процессы, организации и их взаимоотношения по ключевым
ПРИЛОЖЕНИЕ D (справочное) Библиография
ПРИЛОЖЕНИЕ D (справочное) Библиография [1] ИСО/МЭК 12119-94[*] Информационная технология. Пакеты программ. Требования качества и тестированиеУДК 681.3.06:006.354 ОКС 35.080 П85 ОКСТУ 5001Ключевые слова: обработка данных, оборудование обработки данных, вычислительные машины, программные
ПРИЛОЖЕНИЕ А (справочное) Перекрестные ссылки с ГОСТ Р ИСО/МЭК 12207
ПРИЛОЖЕНИЕ А (справочное) Перекрестные ссылки с ГОСТ Р ИСО/МЭК 12207 Настоящий стандарт соответствует ГОСТ Р ИСО/МЭК 12207 в части реализации его подраздела 6.1 по отношению к документации пользователя (см. таблицу А.1).Таблица А.1 — Перекрестные ссылки с ГОСТ Р ИСО/МЭК 12207 Пункты
ПРИЛОЖЕНИЕ В (справочное) Использование настоящего стандарта в договоре
ПРИЛОЖЕНИЕ В (справочное) Использование настоящего стандарта в договоре B.1 Общие положения В настоящем стандарте имеются разделы, требования которых необходимо пояснить применительно к конкретному договору или другим ссылочным документам (например, международным). В
ПРИЛОЖЕНИЕ F (справочное) Оценка проекта
ПРИЛОЖЕНИЕ F (справочное) Оценка проекта F.1 Общие положения В настоящем приложении представлен ряд рекомендуемых методов оценки проекта. В ряде случаев эти методы противоречат друг другу, так как оценка проекта документирования достаточно субъективна. В частности,
ПРИЛОЖЕНИЕ G (справочное) Оценка плана документирования
ПРИЛОЖЕНИЕ G (справочное) Оценка плана документирования Использование настоящего стандарта во взаимоотношениях между заказчиком и документатором способствует созданию качественной документации в частности потому, что между ними согласовывается план
ПРИЛОЖЕНИЕ Н (справочное) Образец спецификации стиля
ПРИЛОЖЕНИЕ Н (справочное) Образец спецификации стиля Н.1 Общие положения Представленный образец спецификации стиля документации соответствует требованиям 8.2 и по умолчанию может быть использован в плане документирования.Примечание — Перед окончательным принятием
Приложение № 3 ТЕХНОЛОГИЯ ПРОИЗВОДСТВА ИЗДЕЛИЙ ИЗ БУМАЖНОЙ МАССЫ
Приложение № 3 ТЕХНОЛОГИЯ ПРОИЗВОДСТВА ИЗДЕЛИЙ ИЗ БУМАЖНОЙ МАССЫ Для приготовления 1 кг бумажной массы (мастики) берется (в г):Мел молотый — 450Клей казеиновый марки ОБ — 200Олифа натуральная — 100Канифоль — 20Бумажная пыль (кноп) — 200Квасцы алюминиевые — 15Глицерин
ПРИЛОЖЕНИЕ А (справочное) Соответствие ИСО 9001-94, ИСО 9002-94 и ИСО/МЭК 17025-99
ПРИЛОЖЕНИЕ А (справочное) Соответствие ИСО 9001-94, ИСО 9002-94 и ИСО/МЭК 17025-99 Таблица А.1 ИСО 9001-94 ИСО 9002-94 ИСО/МЭК 17025-99 Раздел 1 Раздел 1 Раздел 1 Раздел 2 Раздел 2 Раздел 2 Раздел 3 Раздел 3 Раздел 3 4.1.1 4.1.1 4.1.3, 4.2.2 4.1.2.1 4.1.2.1 4.1.5 a), f)-h); 4.2.4; 4.9.1. а); 4.10.1 и 5.2.5 4.1.2.2 4.1.2.2 4.1.5 a), g),
ПРИЛОЖЕНИЕ С (справочное) Библиография
ПРИЛОЖЕНИЕ С (справочное) Библиография ИСО 5725-1-94 Точность (достоверность и сходимость) методов и результатов измерений. Часть 1. Основные принципы и определенияИСО 5725-2-94 Точность (достоверность и сходимость) методов и результатов измерений. Часть 2. Основной метод
ПРИЛОЖЕНИЕ А (Справочное) ГРАФИЧЕСКОЕ ПРЕДСТАВЛЕНИЕ ПРОГРАММНЫХ КОНСТРУКТИВОВ
ПРИЛОЖЕНИЕ А (Справочное) ГРАФИЧЕСКОЕ ПРЕДСТАВЛЕНИЕ ПРОГРАММНЫХ КОНСТРУКТИВОВ Следующие схематические обозначения программных конструктивов в колонках от А до Н таблицы А.1 являются примерами прикладных графических представлений конструктивов.Колонка «Справка»