8. Дайте определение понятию документирование по. Опишите процесс документирования по. Дайте характеристику и приведите примеры архитектурно-проектной и технической документации.

Документация на программное обеспечение — это документы, сопровождающие ПО, программу или программный продукт. Эти документы описывают то, как работает программа и/или то, как её использовать.

Существует четыре основных типа документации на ПО:

• архитектурная/проектная — обзор программного обеспечения, включающий описание рабочей среды и принципов, которые должны быть использованы при создании ПО;

• техническая — документация на код, алгоритмы, интерфейсы и т.д.

• пользовательская — в отличие от других она описывает лито то, как использовать программу.

• Маркетинговая. Цель: подогреть интерес, информировать пользователей, что делает программа, объяснить положение продукта по сравнению с конкурирующими программами.

1.Проектная документация обычно описывает продукт в общих чертах. Не описывая того, как что-либо будет использоваться, она скорее отвечает на вопрос «почему именно так?» Например, в проектном документе программист может описать обоснование того, почему структуры данных организованы именно таким образом. Описываются причины, почему какой-либо класс сконструирован определённым образом, выделяются паттерны, в некоторых случаях даже даются идеи как можно будет выполнить улучшения в дальнейшем. Ничего из этого не входит в техническую или пользовательскую документацию, но всё это действительно важно для проекта.

2.Техническая документация

При создании программы, одного лишь кода, как правило, недостаточно. Должен быть предоставлен некоторый текст, описывающий различные аспекты того, что именно делает код. Такая документация часто включается непосредственно в исходный код или предоставляется вместе с ним.

Подобная документация имеет сильно выраженный технических характер и в основном используется для определения и описания API, структур данных и алгоритмов.

8. Дайте определение понятию документирование по. Опишите процесс документирования по.Дайте характеристику и приведите примеры пользовательской и маркетинговой документации.

Документация на программное обеспечение — это документы, сопровождающие ПО, программу или программный продукт. Эти документы описывают то, как работает программа и/или то, как её использовать.

Существует четыре основных типа документации на ПО:

• архитектурная/проектная — обзор программного обеспечения, включающий описание рабочей среды и принципов, которые должны быть использованы при создании ПО;

• техническая — документация на код, алгоритмы, интерфейсы и т.д.

• пользовательская — В отличии от других она описывает лито то, как использовать программу.

• вводное руководство – для новых пользователей;

• тематический подход – каждая глава посвящена отдельной теме;

• алфавитный справочник.

• Маркетинговая. Цель: подогреть интерес, информировать пользователей, что делает программа, объяснить положение продукта по сравнению с конкурирующими программами.

Пользовательская документация

В отличие от технической документации, сфокусированной на коде и том как он работает, пользовательская документация описывает лишь то, как использовать программу. Пользовательская документация представляет из себя руководство пользователя, которое описывает каждую функцию программы, а также шаги, которые нужно выполнить для использования этой функции, предоставляет инструкции о том что делать в случае возникновения проблем. Очень важно, чтобы документация не вводила в заблуждение и была актуальной. Руководство должно иметь чёткую структуру; Логическая связность и простота также имеют большое значение.

Существует три подхода к организации пользовательской документации. Вводное руководство (англ. tutorial), наиболее полезное для новых пользователей, последовательно проводит по ряду шагов, служащих для выполнения каких-либо типичных задач. Тематический подход, при котором каждая глава руководства посвящена какой-то отдельной теме, больше подходит для совершенствующихся пользователей. В третьем подходе, команды или задачи организованы в виде алфавитного справочника — часто это хорошо воспринимается продвинутыми пользователями, хорошо знающими, что они ищут.

Маркетинговая документация

Для многих приложений необходимо располагать рядом рекламных материалов, с тем чтобы заинтересовать людей, обратив их внимание на продукт. Такая форма документации имеет целью:

• подогреть интерес к продукту у потенциальных пользователей

• информировать их о том, что именно делает продукт, с тем чтобы их ожидания совпадали с тем что они получат

• объяснить положение продукта по сравнению с конкурирующими решениями

Одна из хороших маркетинговых практик — предоставление слогана — простой запоминающейся фразы, иллюстрирующей то что мы хотим донести до пользователя, а также характеризующей ощущение, которое создаёт продукт.