Содержание лекции: виды программных документов; пояснительная записка; руководство пользователя.
Цель лекции: ознакомиться с видами программных документов и основными правилами оформления программной документации.
Одним из главных отличий программы от программного продукта является наличие разнообразной, хорошо подготовленной документации. Составление программной документации — важный процесс. На каждый программный продукт должна разрабатываться документация двух типов: для пользователей различных групп и для разработчиков. Отсутствие документации любого типа для конкретного ПО не допустимо. При подготовке документации не следует забывать, что она разрабатывается для того, чтобы ее использовали, и потому она должна содержать все необходимые сведения [1].
К программным относят документы, содержащие сведения, необходимые для разработки, сопровождения и эксплуатации программного обеспечения. Документирование программного обеспечения осуществляется в соответствии с Единой системой программной документации (ГОСТ 19.ХХХ). Так ГОСТ 19.101-77 устанавливает виды программных документов для ПО различных типов.
«Разработка ТЗ по ГОСТ 34» – Кристина Стец | SoftTeco PM/BA Talks
К основным программным документам по этому стандарту относятся: спецификация, ведомость держателей подлинников, текст программы, описание программы, ведомость эксплуатационных документов, формуляр, описание применения, руководство системного программиста, руководство программиста, руководство оператора, описание языка, руководство по техническому обслуживанию, программа и методика испытаний, пояснительная записка. Допускается объединять отдельные виды эксплуатационных документов. Необходимость объединения указывается в техническом задании, а имя берут у одного из объединяемых документов. При оформлении текстовых и графических материалов, входящих в программную документацию также следует придерживаться действующих стандартов. Рассмотрим подробнее некоторые из перечисленных документов.
Самым главным документом для разработчиков является техническое задание (ТЗ), в котором описываются цели и задачи работы, заказчик и исполнители, технические требования, сроки и этапы, требования секретности, форс-мажорные обстоятельства и правила предъявления результатов. ТЗ должно быть составлено таким образом, чтобы исключить возможные разночтения, все требования должны быть сформулированы так, чтобы их можно было проверить однозначным образом.
Следующим по важности документом является программа и методика испытаний (ПМИ). Структурно она подобна ТЗ – практически для каждого пункта ТЗ в ПМИ говорится, как этот пункт будет проверяться. Способы проверки могут быть самыми разными – от пропуска специального теста до изучения исходных текстов программы, но они должны быть предусмотрены заранее, а не придумываться в момент испытаний. Новички приступают к составлению ПМИ непосредственно перед завершением работ, а опытные руководители составляют и согласовывают с заказчиками одновременно с ТЗ. Хорошо составленная ПМИ является гарантией успешной сдачи работ.
Автоматизация исполнительной документации. Автозаполнение актов скрытых работ АОСР, ОЖР, реестра.
Руководство системного программиста, на современном языке называется руководством по инсталляции. В нем описывается порядок установки системы, как проверить корректность поставленной системы, как вносить изменения и т.п. Обычно это простой короткий документ.
Руководство оператора (пользователя) – это основной документ, описывающий, как пользоваться системой [16]. В хорошем руководстве сначала описывается идея системы, основные функции и как ими пользоваться, а уже потом идет описание всех клавиш и меню.
Руководство программиста — это самый объемный документ, описывающий внутреннюю организацию программы. Обычно этот документ идет в паре с документом » текст программы » – одностраничным документом с оглавлением дискеты или CD. Руководство программиста дает заказчику возможность дописать новые фрагменты программы или переделать старые.
В современной литературе этот документ называется SDK (Software Development Kit). Продукт, снабженный SDK, может стоить на порядок дороже, чем такой же продукт без него. Сейчас не принято продавать исходные тексты программ – проблемы с интеллектуальной собственностью, даже при наличии SDK трудно «влезть» в чужую программу – как говорится, себе дороже.
Поэтому большое распространение получили API (Application Program Interface). Программа передается только в виде DLL (библиотека двоичных кодов), но известно, как обратиться к каждой функции из других программ, т.е. известно имя точки входа, количество, типы и значения параметров.
Наличие множества API, конечно, хуже, чем наличие исходных текстов (например, нельзя переделать что-то в середине функции), зато много проще в использовании. С другой стороны, все большую популярность приобретает FSF (Free Software Foundation). Основателем этого движения был Ричард Столман [4], который забил тревогу по поводу попыток крупных фирм запатентовать многие основные алгоритмы и программы: «Дойдет до того, что они запатентуют понятия «цикл» и «подпрограмма», что мы будем тогда делать?» FSF представляет собой собрание программ в исходных текстах; любой программист может свободно использовать их в своих целях, но все добавления и улучшения, которые он сделал, тоже следует положить в FSF. Таким образом, FSF представляет собой одно из самых больших доступных хранилищ программ.
Дополнительную информацию по теме можно получить в [1, 4, 16].
Источник: studopedia.org
17 Лекция № 17. Составление программной документации
Содержание лекции: виды программных документов; пояснительная записка; руководство пользователя.
Цель лекции: ознакомиться с видами программных документов и основными правилами оформления программной документации.
Одним из главных отличий программы от программного продукта является наличие разнообразной, хорошо подготовленной документации. Составление программной документации — важный процесс. На каждый программный продукт должна разрабатываться документация двух типов: для пользователей различных групп и для разработчиков. Отсутствие документации любого типа для конкретного ПО не допустимо. При подготовке документации не следует забывать, что она разрабатывается для того, чтобы ее использовали, и потому она должна содержать все необходимые сведения [1].
К программным относят документы, содержащие сведения, необходимые для разработки, сопровождения и эксплуатации программного обеспечения. Документирование программного обеспечения осуществляется в соответствии с Единой системой программной документации (ГОСТ 19.ХХХ). Так ГОСТ 19.101-77 устанавливает виды программных документов для ПО различных типов.
К основным программным документам по этому стандарту относятся: спецификация, ведомость держателей подлинников, текст программы, описание программы, ведомость эксплуатационных документов, формуляр, описание применения, руководство системного программиста, руководство программиста, руководство оператора, описание языка, руководство по техническому обслуживанию, программа и методика испытаний, пояснительная записка. Допускается объединять отдельные виды эксплуатационных документов. Необходимость объединения указывается в техническом задании, а имя берут у одного из объединяемых документов. При оформлении текстовых и графических материалов, входящих в программную документацию также следует придерживаться действующих стандартов. Рассмотрим подробнее некоторые из перечисленных документов.
Самым главным документом для разработчиков является техническое задание (ТЗ), в котором описываются цели и задачи работы, заказчик и исполнители, технические требования, сроки и этапы, требования секретности, форс-мажорные обстоятельства и правила предъявления результатов. ТЗ должно быть составлено таким образом, чтобы исключить возможные разночтения, все требования должны быть сформулированы так, чтобы их можно было проверить однозначным образом.
Следующим по важности документом является программа и методика испытаний (ПМИ). Структурно она подобна ТЗ – практически для каждого пункта ТЗ в ПМИ говорится, как этот пункт будет проверяться. Способы проверки могут быть самыми разными – от пропуска специального теста до изучения исходных текстов программы, но они должны быть предусмотрены заранее, а не придумываться в момент испытаний. Новички приступают к составлению ПМИ непосредственно перед завершением работ, а опытные руководители составляют и согласовывают с заказчиками одновременно с ТЗ. Хорошо составленная ПМИ является гарантией успешной сдачи работ.
Руководство системного программиста, на современном языке называется руководством по инсталляции. В нем описывается порядок установки системы, как проверить корректность поставленной системы, как вносить изменения и т.п. Обычно это простой короткий документ.
Руководство оператора (пользователя) – это основной документ, описывающий, как пользоваться системой [16]. В хорошем руководстве сначала описывается идея системы, основные функции и как ими пользоваться, а уже потом идет описание всех клавиш и меню.
Руководство программиста — это самый объемный документ, описывающий внутреннюю организацию программы. Обычно этот документ идет в паре с документом «текст программы» – одностраничным документом с оглавлением дискеты или CD. Руководство программиста дает заказчику возможность дописать новые фрагменты программы или переделать старые.
В современной литературе этот документ называется SDK (Software Development Kit). Продукт, снабженный SDK, может стоить на порядок дороже, чем такой же продукт без него. Сейчас не принято продавать исходные тексты программ – проблемы с интеллектуальной собственностью, даже при наличии SDK трудно «влезть» в чужую программу – как говорится, себе дороже.
Поэтому большое распространение получили API (Application Program Interface). Программа передается только в виде DLL (библиотека двоичных кодов), но известно, как обратиться к каждой функции из других программ, т.е. известно имя точки входа, количество, типы и значения параметров.
Наличие множества API, конечно, хуже, чем наличие исходных текстов (например, нельзя переделать что-то в середине функции), зато много проще в использовании. С другой стороны, все большую популярность приобретает FSF (Free Software Foundation). Основателем этого движения был Ричард Столман [4], который забил тревогу по поводу попыток крупных фирм запатентовать многие основные алгоритмы и программы: «Дойдет до того, что они запатентуют понятия «цикл» и «подпрограмма», что мы будем тогда делать?» FSF представляет собой собрание программ в исходных текстах; любой программист может свободно использовать их в своих целях, но все добавления и улучшения, которые он сделал, тоже следует положить в FSF. Таким образом, FSF представляет собой одно из самых больших доступных хранилищ программ.
Дополнительную информацию по теме можно получить в [1, 4, 16].
Источник: studfile.net
Составление программной документации — презентация
Презентация на тему: » Составление программной документации» — Транскрипт:
1 Выполнила: Чайко Екатерина Сергеевна студентка 3 курса, 31-И группы Старый Оскол, 2014 г.
3 Введение Составление программной документации-очень важный процесс. На каждый программный продукт должна разрабатываться документация двух типов: Для пользователей различных групп Для разработчиков
4 I. Документация на программное обеспечение 1.1. Определение документации Документация на программное обеспечение- печатные руководства пользователя, диалоговая (оперативная) документация и справочный текст, описывающие, как пользоваться программным продуктом.
5 1.2. Типы документации Существует четыре основных типа документации на ПО: Архитектурная/проектная Техническая Пользовательская Маркетинговая
6 1.3. Виды программных документов Спецификация Ведомость держателей подлинников Текст программы Описание программы Ведомость эксплуатационных документов Формуляр Описание применения Руководство системного программиста Руководство программиста Руководство оператора Описание языка Руководство по техническому обслуживанию Программа и методика испытаний Пояснительная записка Прочие документы
7 II. Составление программной документации 2.1. Пояснительная записка Содержание пояснительной записки по стандарту ГОСТ должно выглядеть следующим образом: Введение Назначение и область применения Технические характеристики Ожидаемые технико-экономические показатели Источники
8 2.2. Руководство пользователя Руководство пользователя содержит следующие разделы: Общие сведения о программном продукте Описание установки Описание запуска Инструкции по работе Сообщение пользователю
9 2.3. Руководство системного программиста Содержит следующие разделы: Общие сведения о программном продукте Структура Настройка Проверка Дополнительные возможности Сообщение системному программисту
10 2.4. Основные правила оформления программной документации Текстовые документы оформляются на листах формата А4. Поля на листе определяются в соответствии с общими требованиями: левое – не менее 30, правое – не менее 10, верхнее – не менее 15, а нижнее – не менее 20 мм.
11 2.5. Оформление списка литературы Список литературы должен включать все использованные источники. Сведения о книгах, фамилию и инициалы автора, заглавие книги, место издания, издательство, год издания.
12 Заключение Таким образом, были рассмотрены все поставленные вопросы, рассмотрены правила оформления расчетно-пояснительных записок при курсовом проектировании, основные правила оформления программной документации.
13 Список использованных источников
Источник: www.myshared.ru