Иногда может понадобиться составить краткую памятку по проекту. Или его мини-описание.
Иногда это надо делать не для проекта, а для отдельных компонентов функциональности. Как правило, когда дело доходит до компонентов, у аналитиков происходит ясный глюк о том, что все те, кто войдут в проект, будут знать-понимать то же самое, что они сейчас знают-понимают. Соответственно и компоненты описываются без объяснений и предисловий.
А нужно, чтобы «Любой желающий мог быстро прочесть и понять что это за проект, какой там функционал и как юзеры будут его тыркать» (форум).
Можно набросать вот такой документ:
1. Цель проекта
2. Функциональные возможности приложения
<Из каких частей состоит? Для чего они? Что можно сделать? Их зависимости….>
3. Особенности ролей пользователей
<Какие роли могут быть на проекте? Их права, обязанности,…>
4. Варианты использования
<Список основных сценариев использования приложения всеми ролями пользователей>
5. Зависимости проекта с другими системами
<Как будет использоваться? Специфика, интеграции,…>
Но это объёмная вещь. Это не читается быстро, и быстро не понимается. И написано, как всегда, казённым языком священного армейского устава.
Попробуйте кратко объяснить проект любому уличному бомжу.
Начнете в стиле «Мужик, смотри, это нужно для того, чтобы…«. Потом вы осознаете, что нужно контекст объяснять, а не реализацию, и перейдёте на «Чтобы выполнить такую-то задачу, мы используем такую-то шняжку…»
Потом в документах будете всегда писать грамотно и сразу всем всё будет понятно.
Бомжу опосля не забудьте проставиться, он ждёт вас.
Понравилось это:
Нравится Загрузка...
