← Разработка технической документации

Проектная документация. Проектная документация в IT


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

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


    • Перечень входных сигналов и данных
    • Описание автоматизируемых функций
    • Описание информационного обеспечения системы
    • Описание массива информации
    • Описание интеграционного решения
    • Описание комплекса технических средств
    • Описание программного обеспечения
    • Описание постановки задач (комплекса задач)
    • Описание организации информационной базы
    • Описание систем классификации и кодирования
    • Описание организационной структуры
    • Спецификация оборудования
    • Массив входных данных
    • Каталог базы данных
    • Состав выходных данных (сообщений)
Программная документация – документация, содержащая сведения, необходимые для разработки, изготовления, эксплуатации и сопровождения программы (код, алгоритмы, структуры данных, интерфейсы, API).

Разработка пользовательской документации


Любое программное обеспечение сопровождается пользовательской документацией.

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

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

Эксплуатационная документация


    • Ведомость эксплуатационных документов
    • Технологическая инструкция
    • Руководство пользователя
    • Руководство администратора
    • Руководство администратора базы данных
    • Инструкция по формированию и ведению базы данных (набора данных)
    • Инструкция по эксплуатации КТС
    • Схема деления системы (структурная)
    • Описание технологического процесса обработки данных (включая телеобработку)
    • Общее описание системы
    • Программа и методика испытаний (компонентов, комплексов средств автоматизации, подсистемы, систем)
    • Формуляр
    • Паспорт
Эксплуатационная документация – документация, необходимая для обеспечения функционирования и эксплуатации программного изделия (руководства, инструкции, паспорта).