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

ЗАКАЗЧИК

Заказчик является белорусским филиалом американской компании-разработчика программного обеспечения с центрами разработки в странах Восточной Европы и представительствами в Великобритании и Германии. К настоящему времени компания выполнила проекты для заказчиков из 31 страны.

Компания: разработчик программного обеспечения

Страна: Беларусь/США

Сфера деятельности: программное обеспечение для систем наблюдения

Оказанные услуги: создание технической документации

Модель сотрудничества: оказание услуг по разработке технической документации сторонней компании

Трудозатраты: 160 человеко-часов

ПРОЕКТ

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

Компания уже в течение нескольких лет продает разработанное решение в качестве готового продукта.

ЗАДАЧА

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

Некоторая документация, подготовленная разработчиками, уже была в наличии. Однако использовать ее в том виде, в котором она существовала, не представлялось возможным по нескольким причинам:

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

РЕШЕНИЕ

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

• Изучение структуры и функциональных возможностей продукта;
• Оценка трудозатрат, необходимых для выполнения проекта.

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

ИСПОЛЬЗОВАННЫЕ ТЕХНОЛОГИИ

Операционная система: MS Windows 2000 SP4

Окружение: .NET

СУБД: MS SQL Server

Инструменты для создания документации: Microsoft Office Word 2003 (для написания и редактирования), TechSmith SnagIt v. 7.03 (для создания снимков экрана)

РЕЗУЛЬТАТЫ

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

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

Конечный заказчик получил всеобъемлющую пользовательскую документацию, которая была гораздо лучше существующей. Это позволило:

• Улучшить сам программный продукт;
• Предложить улучшенную новую версию программы уже существующим покупателям;
• Лучше продавать продукт.

Скачать файл

Связаться с нами