Форум Сообщества Аналитиков

Общий раздел => Для всех => Тема начата: m2broth от 06 Октября 2010, 22:49:10

Название: нужна помощь по техническому заданию!
Отправлено: m2broth от 06 Октября 2010, 22:49:10

Как задокументировать класс в документе, чтобы и пользователь и программист мог понять как им пользоваться? Ниже вложен данный класс

Название: Re: нужна помощь по техническому заданию!
Отправлено: bas от 06 Октября 2010, 22:53:41

А причем тут класс и пользователь?

Название: Re: нужна помощь по техническому заданию!
Отправлено: Galogen от 06 Октября 2010, 22:57:30

Странная постановка вопроса. Зачем документировать класс в виде ТЗ? ТЗ - контракт между разработчиком и заказчиком на то, что должно быть сделано за какой срок и с каким качеством.

Каким образом, поясните мне, пользователь должен пользоваться классом? Тоже странная постановка вопроса. Пользователь пользуется не классом. Он взаимодействует с системой через интерфейс, вероятнее всего через GUI. Для этого предназначена рабочая документация - инструкции пользователю, справка и т.п.

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

Название: Re: нужна помощь по техническому заданию!
Отправлено: m2broth от 06 Октября 2010, 22:58:22

мне тот же самый вопрос задали на фирме:)