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

Agile XP , Lean , Scrum , FDD и др. Документ — элемент документации: Программный документ — документ, содержащий в зависимости от назначения данные, необходимые для разработки, производства, эксплуатации, сопровождения программы или программного средства [2].

Документация программных изделий

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

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

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

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

Они получают информацию из специальным образом оформленных комментариев в исходном коде, и создают справочные руководства в каком-либо формате, например, в виде текста или HTML. Использование генераторов документации и документирующих комментариев многими программистами признаётся удобным средством, по различным причинам. В частности, при таком подходе документация является частью исходного кода, и одни и те же инструменты могут использоваться для сборки программы и одновременной сборки документации к ней.

Это также упрощает поддержку документации в актуальном состоянии. В отличие от технической документации, сфокусированной на коде и том, как он работает, пользовательская документация описывает лишь то, как использовать программу. В случае если продуктом является программная библиотека , пользовательская документация и документация на код становятся очень близкими, почти эквивалентными понятиями.

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

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

Документация на программное обеспечение

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

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

Документация на программное обеспечение (ПО)

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

Обеспечение систем обработки информации программное. Стадии разработки Анализ требований Проектирование Программирование Тестирование.

Документация программных изделий

Архитектура ПО Парадигма Методология Процесс разработки Качество. Программирование Аспектно-ориентированное Объектно-ориентированное Проблемно-ориентированное. Agile Cleanroom CASE UP RUP OpenUP RAD Scrum SAFe Spotify Model MSF XP DSDM.

Итеративная Каскадная Спиральная V-Model Dual Vee Model CMM CMMI Данных Function model IDEF Информационная Метамодель Object model View model UML. Кент Бек Гради Буч Фред Брукс Уорд Каннингем Оле-Йохан Даль Том Демарко Эдсгер Дейкстра Дональд Кнут Алан Кэй Мартин Фаулер Энтони Хоар Ивар Якобсон Бертран Мейер Никлаус Вирт Эдвард Йордан Стив Макконнелл Джеймс Рамбо Барри Боэм [en] Уоттс Хамфри [en] Майкл А. Джексон [en] Крэг Ларман Джеймс Мартин [en] Дэвид Парнас [en] Уинстон Ройс [en]. Техническая документация Программное обеспечение Разработка программного обеспечения.

Навигация Персональные инструменты Вы не представились системе Обсуждение Вклад Создать учётную запись Войти. Пространства имён Статья Обсуждение. Просмотры Читать Править Править вики-текст История. Эта страница последний раз была отредактирована 13 июня в Текст доступен по лицензии Creative Commons Attribution-ShareAlike ; в отдельных случаях могут действовать дополнительные условия.

Свяжитесь с нами Политика конфиденциальности Описание Википедии Отказ от ответственности Разработчики Соглашение о cookie Мобильная версия. Эта статья или раздел нуждается в переработке.

Опубликовано в рубрике Xerox
Twitter Delicious Facebook Digg Stumbleupon Favorites More
  • Прикрепленное видео

Все права защищены. © 2001 toozza.ru