Автор работы: Пользователь скрыл имя, 07 Февраля 2013 в 23:05, курсовая работа
При разработке ПС создается большой объем разнообразной документации. Она необходима как средство передачи информации между разработчиками ПС, как средство управления разработкой ПС и как средство передачи пользователям информации, необходимой для применения и сопровождения ПС. На создание этой документации приходится большая доля стоимости ПС.
Введение 3
ГЛАВА 1. Стандарты оформления документации 4
1.1 Процесс документирования. 6
1.2 План документирования. 7
1.3 Содержание спецификации стиля 9
ГЛАВА 2. Проектная документация 11
2.1 Техническое задание 14
2.2 Внутренние и внешние языки спецификации 16
2.3 Документация по сопровождению программы 17
Глава 3.Пользовательская документация. 19
3.1 Категории пользователей 20
3.2 Состав пользовательской документации 21
Заключение 23
Список литературы 25
Приложения 26
Эксплуатационная документация
на программный продукт
Документ |
Аудитория |
Примерное содержание |
описание программы |
лица, принимающие решения о приобретении, вводе в эксплуатацию и способах использования программы |
назначение и основные возможности программы, необходимые ей нее системные ресурсы, входные и выходные данные |
описание применения | ||
описание языка |
пользователи языка (программисты, операторы, кодеры, верстальщики) |
основная идея языка, его синтаксис, элементы и конструкции, встроенные функции |
паспорт |
лица, ответственные за эксплуатацию программы |
краткие сведения о программе и условиях ее поставки |
руководство администратора |
ответственный пользователь системы, обеспечивающий ее целевое применение |
управление учетными записями пользователей, назначение пользователям прав доступа, ведение нормативно-справочной информации, загрузка и выгрузка данных |
руководство оператора |
операторы, работающие с системой, частью которой является программа |
порядок выполнения предусмотренных операций, сообщения программы и предписанные оператору способы реакции на них |
руководство пользователя |
пользователи программы, т.е. лица, применяющие ее для решения собственных прикладных задач |
назначение и возможности программы, ее основные концепции, интерфейс пользователя, порядок решения типовых задач, описание функций программы |
руководство программиста |
программисты, сопровождающие программу или использующие ее в качестве платформы либо средства разработки при создании собственных программ |
архитектура программы или создаваемых на ее основе приложений, описание программных интерфейсов к ее объектам, протоколов обмена данными и т. п. |
руководство системного администратора (системного программиста) |
системные администраторы, осуществляющие
установку программы и |
установка программы, ее интеграция в систему, проверка правильности функционирования, устранение аварийных ситуаций |
спецификация |
лица, ответственные за эксплуатацию программы |
комплект поставки программы |
справочная система («хелп») |
пользователи, операторы, администраторы, системные администраторы, программисты и др. |
материал всех имеющихся руководств и описаний, краткие описания элементов интерфейса пользователя программы |
формуляр |
лица, ответственные за эксплуатацию программы |
краткие сведения о программе и условиях ее поставки, записи эксплуатационного о возникающих сбоях и прочих событиях такого рода |
Размещено на Allbest.ru
1 Документатор не отвечает за разработку, проверку или корректировку исходных материалов, а только за их получение.
2 Обычно план документирования должен охватывать весь комплект документации, например руководства пользователя, диалоговую документацию, справочные тексты и краткие справочные карты
3 Вопрос прав собственности является сложным. Во всех договорах на документацию должны быть указаны собственники соответствующих прав. При этом может быть указана последующая возможность передачи авторских прав от документатора к заказчику. Передача авторских прав целесообразна при определении места и способа тиражирования документации;
4 Конкретные лица привлекаются на различных этапах написания и производства (тиражирования) документации в зависимости от уровня своего опыта и знаний. Например, может быть необходимым хорошее знание автором документируемой системы и опыт в написании документации; для редактора может потребоваться только опыт редактирования, но не знание системы; от компоновщика (оформителя) может не требоваться других знаний кроме знания средств оформления;
5 Должен быть определен национальный орфографический словарь, удовлетворяющий интересам основной аудитории пользователей в данной стране. По возможности словарь следует представить в виде файла орфографического контроля.
6 Должен быть определен стандарт по национальной грамматике и ее применению в интересах основной аудитории пользователей в данной стране.