Пользовательская документация
Документация на программное обеспечение. Пользовательская, маркетинговая документация.
Изучить лекцию и ответить на вопросы.
Документация на программное обеспечение — это документы, сопровождающие некоторое программное обеспечение (ПО) — программу или программный продукт. Эти документы описывают то, как работает программа и/или то, как её использовать.
Документ - элемент документации: целевая информация, предназначенная для конкретной аудитории, размещенная на конкретном носителе (например, в книге, на диске, в краткой справочной карте) в заданном формате.
Программная документация — документы, содержащие в зависимости от назначения данные, необходимые для разработки, производства, эксплуатации, сопровождения программы или программного средства
Существует четыре основных типа документации на ПО:
· архитектурная/проектная — обзор программного обеспечения, включающий описание рабочей среды и принципов, которые должны быть использованы при создании ПО
· техническая — документация на код, алгоритмы, интерфейсы, API
· пользовательская — руководства для конечных пользователей, администраторов системы и другого персонала
· маркетинговая
Цели документирования:
ü посредничество между разработчиками ПО;
ü упрощение сопровождения и эволюции;
ü информация для планирования и оценки затрат в процессе разработки;
|
|
|
ü инструкции по использованию и управлению программной системой;
ü основание для сертификации системы
Типы документации
Документация на процесс разработки (англ. process documentation ) - внутренняя документация —используется в процессе разработки программного обеспечения и недоступна конечному пользователю (различные внутренние стандарты, комментарии исходного текста, технологии программирования и т.д.) :
▶ планы разработки;
▶ расписания;
▶ документы оценки качества процессов разработки;
▶ организационные и проектные стандарты.
Документация на продукты разработки (англ. product documentation) - внешняя документация- всевозможные руководства для пользователей, техническое задание, справочники :
▶ системная (техническая) документация описание программной системы с точки зрения разработчика;
▶ пользовательская документация описание ПО с точки зрения конечного пользователя.
Недостатки традиционного подхода к документированию:
▶Производство документации и поддержка документов в актуальном состоянии занимает много времени и средств и приводит к замедлению процесса разработки.
▶Требования к ПО меняются настолько быстро, что документация устаревает практически сразу после написания.
|
|
|
Необходимые виды документации:
▶пользовательская документация;
▶обоснование архитектурных решений;
▶документация критических систем.
Форматы документации
▶Печатная документация;
▶Электронная документация:
- локальные файлы (plain text, Markdown, HTML, PDF, …);
- интегрируемая в общесистемную справочную систему (man, info, …);
- интегрируемая в среду разработки (напр., исходные Java-файлы или javadoc-архивы при разработке на Java в Eclipse).
▶Онлайн-документация:
- поддерживаемая разработчиком (руководство по установке / Getting started / справочные руководства, …);
- Web 2.0-документация, поддерживаемая пользователями (wiki, блоги, вопросы на stackoverflow, …)
Ведение электронной документации предоставляет дополнительные возможности для делопроизводства, делая процессы подготовки и обработки документов более эффективными, но в то же время накладывает и некоторые ограничения и предъявляет определенные требования к организации рабочих мест документоведов.
Преимущества использования электронных документов:
Недостатки:
Пользовательская документация
В отличие от технической документации, сфокусированной на коде и том, как он работает, пользовательская документация описывает лишь то, как использовать программу.
|
|
|
Пользовательская документация (англ. user documentation) документы, описывающие использование программной системы конечными пользователями.
Обычно, пользовательская документация представляет собой руководство пользователя, которое описывает каждую функцию программы, а также шаги, которые нужно выполнить для использования этой функции. Хорошая пользовательская документация идёт ещё дальше и предоставляет инструкции о том, что делать в случае возникновения проблем. Очень важно, чтобы документация не вводила в заблуждение и была актуальной. Руководство должно иметь чёткую структуру; очень полезно, если имеется сквозной предметный указатель. Логическая связность и простота также имеют большое значение.
Существует три подхода к организации пользовательской документации.
Вводное руководство (англ. tutorial), наиболее полезное для новых пользователей, последовательно проводит по ряду шагов, служащих для выполнения каких-либо типичных задач.
Тематический подход, при котором каждая глава руководства посвящена какой-то отдельной теме, больше подходит для совершенствующихся пользователей.
|
|
|
В последнем, третьем подходе, команды или задачи организованы в виде алфавитного справочника — часто это хорошо воспринимается продвинутыми пользователями, хорошо знающими, что они ищут. Жалобы пользователей обычно относятся к тому, что документация охватывает только один из этих подходов, и поэтому хорошо подходит лишь для одного класса пользователей.
Во многих случаях разработчики программного продукта ограничивают набор пользовательской документации лишь встроенной системой помощи (англ. online help), содержащей справочную информацию о командах или пунктах меню. Работа по обучению новых пользователей и поддержке совершенствующихся пользователей перекладывается на частных издателей, часто оказывающих значительную помощь разработчикам.
Организация пользовательской документации:
- учебные пособия описание шагов для решения определенных задач с помощью
программной системы;
- темы объединение логически связанных документов в главы / разделы,
описывающие определенный аспект ПО;
- справочники перечень выполняемых системой функций.
Дата добавления: 2022-07-02; просмотров: 80; Мы поможем в написании вашей работы! |
Мы поможем в написании ваших работ!