Глава 7. Техническая документация


Техническое задание3

Для выполнения проекта

С известным качеством и сроком

Весьма полезным документом

ТЗ является. Во многом


Его задача – однозначность

При понимании системы.

В ТЗ описаны задачи

Проекта так, чтоб были всеми


Они восприняты в едином

Ключе и смысле, и трактовок

Различных не было в картине

И описании разработок.


Частное техническое задание

Когда проект большой ведётся,

И разработчиков в нём много,

На подсистемы создаётся

Задание частное в итоге.


Технический проект4

Все описания дальнейших

Проектных принятых решений

Технический проект содержит,

В нём излагают о системе


Устройство, алгоритмы, схемы,

От базы данных до внедрения

И эффективности системы.

На языке для исполнения:


Когда ТЗ для всех понятно,

ТП – уже для программиста –

В нём не столь нужно деликатно

Искоренять все жаргонизмы.


Руководство пользователя

Когда написана система,

Для помощи в работе с нею

Полезна текстовая схема,

Чтоб описать её идею


Для пользователей и просто

Помочь в процессе изучения

Её работы – руководство.

Обычно в нем обозначение


Дается следующим вопросам:

Обзор и ссылки, назначение

Системы, функции и способ

Их применения, и решение


Проблем возможных при работе

И при типичном применении.

Полезный документ для многих,

При изучении приложения.


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

Администратору в работе

Инструкция нужна другая –

В ней описание даёте

Как доступ, роли назначают,


Как заполняют базы данных

И разворачивают сервер,

Как исправлять ошибки надо,

Коль есть известные примерно.


Программа и методика испытаний5

Когда проект идёт к внедрению,

Бывает нужен документ,

В котором есть определение,

Как «тестить» каждый элемент.


Программа тестов-испытаний

При разработке под заказ

Даёт возможность понимания,

Что как проверить и, подчас,


Нужна не менее задания

На разработку, ведь по ней

Проводится согласование

С заказчиком системы всей.


В ней нужен список всех условий

Для выполнения работ,

Сценарий, тесты, по которым

Заказчик проверять пойдёт.

Загрузка...