Руководство системного программиста

Выполнила: Устенко
Виктория Сергеевна
студентка 3 курса,
31-И группы
ВВЕДЕНИЕ
1.1. Составление программной документации
1.2. Виды программных документов.
1.3.Пояснительная записка
1.4.Руководство пользователя
1.5. Руководство системного программиста
1.6. Основные правила оформления программной документации
1.7. Оформления списка литературы
1.8. Правила оформления расчетно-пояснительных записок
при курсовом проектировании
1.9. Документирование программных средств
1.10. Пользовательская документация программных средств
1.11. Документация по сопровождению программных средств
ЗАКЛЮЧЕНИЕ
СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ
ВВЕДЕНИЕ
На всех стадиях жизненного цикла промышленной продукции
(программа/комплекс, автоматизированная система и устройство)
необходима разработка документации, которая в полной мере
должна обеспечить пользователя всеми необходимыми знаниями.
От того насколько техническая документация будет полной,
информативной и что, немаловажно правильно выполненной,
зависит успех продукции на рынке.
1.1. Составление программной документации
Составление программной документации — очень важный процесс.
Стандарт, определяющий процессы жизненного цикла программного
обеспечения, даже предусматривает специальный процесс,
посвященный указанному вопросу.
При этом на каждый программный продукт должна разрабатываться
документация двух типов: для пользователей различных групп и для
разработчиков.
При подготовке документации не следует забывать, что она
разрабатывается для того, чтобы ее можно было использовать, и потому
она должна содержать все необходимые сведения.
1.2. Виды программных документов
К программным относят документы, содержащие сведения,
необходимые для разработки, сопровождения и эксплуатации
программного обеспечения. Документирование программного
обеспечения осуществляется в соответствии с Единой системой
программной документации (ГОСТ 19.ХХХ). Так ГОСТ 19.101-77
устанавливает виды программных документов для программного
обеспечения различных типов. Ниже перечислены основные
программные документы по этому стандарту.
1.2. Виды программных документов
Спецификация;
Ведомость держателей подлинников;
Текст программы;
Описание программы;
Ведомость эксплуатационных документов;
Формуляр;
Описание применения;
Руководство системного программиста;
1.2. Виды программных документов
Руководство программиста;
Руководство оператора;
Описание языка;
Руководство по техническому обслуживанию;
Программа и методика испытаний;
Пояснительная записка;
Прочие документы.
1.3.Пояснительная записка
Пояснительная записка должна содержать всю информацию,
необходимую для сопровождения и модификации программного
обеспечения.
Содержание пояснительной записки по стандарту (ГОСТ 19.40479) должно выглядеть следующим образом:
• введение;
• назначение и область применения;
• технические характеристики;
• ожидаемые технико-экономические показатели;
• источники, используемые при разработке.
1.4.Руководство пользователя
Руководство пользователя, как правило, содержит следующие
разделы:
• общие сведения о программном продукте;
• описание установки;
• описание запуска;
• инструкции по работе (или описание пользовательского
интерфейса);
• сообщения пользователю.
1.5. Руководство системного программиста
Руководство системного программиста должно содержать
следующие разделы:
• общие сведения о программном продукте,
• структура,
• настройка,
• проверка,
• дополнительные возможности,
• сообщения системному программисту.
1.6. Основные правила оформления
программной документации
При оформлении текстовых и графических материалов,
входящих в программную документацию следует придерживаться
действующих стандартов.
Оформление текстового и графического материала. Текстовые
документы оформляют на листах формата А4, причем графический
материал допускается представлять на листах формата A3. Поля на
листе определяют в соответствии с общими требованиями: левое не менее 30, правое - не менее 10, верхнее - не менее 15, а нижнее не менее 20 мм, и т.д.
1.7. Оформления списка литературы
Список литературы должен включать все использованные источники.
Сведения о книгах (монографиях, учебниках, пособиях, справочниках
и т. д.) должны содержать: фамилию и инициалы автора, заглавие
книги, место издания, издательство, год издания.
Сведения о статье из периодического издания должны включать:
фамилию и инициалы автора, наименование статьи, издания
(журнала), серии, год выпуска, и т.д.
При ссылке на источник из списка литературы (особенно при обзоре
аналогов) надо указывать порядковый номер по списку литературы,
заключенный в квадратные скобки; например: [5].
1.8. Правила оформления расчетно-пояснительных
записок при курсовом проектировании
В соответствии с стандартом(ИСС 5966-82) текстовый документ
подобного типа должен включать:
- титульный лист;
- реферат;
- содержание;
- введение;
- основную часть;
- заключение;
- список использованных источников, в том числе литературы.
- приложения.
1.9. Документирование программных средств
При разработке ПС создается большой объем разнообразной
документации. Она необходима как средство передачи информации
между разработчиками ПС, как средство управления разработкой ПС
и как средство передачи пользователям информации, необходимой
для применения и сопровождения ПС.
1.10. Пользовательская документация
программных средств
Пользовательская документация ПС объясняет пользователям, как
они должны действовать, чтобы применить данное ПС. Она
необходима, если ПС предполагает какое-либо взаимодействие с
пользователями.
К такой документации относятся документы, которыми
руководствуется пользователь при инсталляции ПС (при установке
ПС с соответствующей настройкой на среду применения ПС), при
применении ПС для решения своих задач и при управлении ПС
(например, когда данное ПС взаимодействует с другими системами).
1.11. Документация по сопровождению
программных средств
Документация по сопровождению ПС (system documentation)
описывает ПС с точки зрения ее разработки. Эта документация
необходима, если ПС предполагает изучение того, как оно
устроена (сконструирована), и модернизацию его программ.
ЗАКЛЮЧЕНИЕ
Таким образом, программная документация является
неотъемлемым компонентом программного продукта и должна
оформляться в соответствии с Единой системой программной
документации (ЕСПД - ГОСТ серии 19). В рамках учебных работ
допускается заключать всю содержательную часть программной
документации в единый "отчёт по программе", при этом
формальные требования к оформлению такого отчёта
соответствуют требованиям к отчёту по НИР. В данном разделе
изложены ключевые моменты государственных стандартов ЕСПД.
СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ
1. http://www.ergeal.ru/archive/cs/tp/ - Технология
программирования, конспект лекций ВМиК МГУ, кафедра
системного программирования;
2. http://www.aanet.ru/~web_k46/textbooks/std_pro/face.htm Богданов Д.В., Путилов В.А., Фильчаков В.В. Стандартизация
процессов обеспечения качества программного обеспечения. Апатиты, КФ ПетрГУ, 1997. ;
3. Ian Sommerville. Software Engineering. - Addison-Wesley
Publishing Company, 1992. P.;
4. ГОСТ Р ИСО/МЭК 15910-2002 — Процесс создания
документации пользователя программного средства;