Визуализация программы

Question

Я начинаю с веб-проекта, и я хотел бы написать его функциональность и функции на «листе бумаги», как это делают профессионалы. Я должен подготовить документацию по проекту со всей информацией о цели и проекта обзора по

• ,
• структуру базы данных,
• MVC и функциональность REST (модель, вид, контроллер),
• сайт и макеты виджетов и функциональность,
• связь клиент/сервер.

Что я хотел бы подготовить, это предложение по проекту, в котором я объясняю идею и точное решение и как ее выполнять со всеми деталями.

Как это подготовить? Что мне нужно? Можете ли вы показать мне пример?

Answer 1

Профессионалы сосредоточены на аудитории. Какова цель этого документа, рассказ, который он должен рассказать? Письмо требует времени, и это должно уравновешиваться другими способами, чтобы провести время.

Нужно ли продавать проект покупателю? Или руководству? Инвесторы? Или вашим со-разработчикам? Или это в основном для вас самих?

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

Достаточно ли просто сделать несколько снимков с белыми досками или сеансами коричневой бумаги, или вам нужна глянцевая брошюра, видео и powerpoint?

Для веб-проекта вы можете поместить все это в вики.

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

Answer 2

Отдельные требования от реализации. Я бы получил первоначальный документ, фиксирующий «что» в системе.

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

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

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

Будет создана «Модель данных интерфейса», связанная с этими артефактами. Данные, отображаемые на участках и возвращаемые любыми публичными службами. Это может быть смоделировано в вашем выборе инструмента моделирования данных (я бы использовал диаграммы классов UML).

В разработке ...Уровень MVC и подробная логика бизнес-процессов могут быть смоделированы с использованием методов OO, снова UML отлично работает.

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

Answer 3

Я бы посоветовал вам написать два документа:

• Одно техническое описание: Где вы будете писать все технические вещи, от структуры базы данных для описания протоколов, если это необходимо.

• Описание: Если вы напишете весь функциональный материал, с целью проекта, описание каждой функциональности вашего приложения.

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

Когда я хочу быть уверенным, что мои технические и функциональные документы полезны, я пишу им: «Если я умру завтра, я хочу, чтобы люди, которые прочитали эти документы, все время поняли приложение, и я хочу, чтобы они будьте уверены, как это сделать, точно так же, как я бы хотел, чтобы это было сделано ». В конечном итоге я вникаю в детали приложения, но это, как правило, хорошая идея. Я заметил, что чем больше времени я трачу на запись этих документов, тем меньше звонков, которые я получаю позже, и менее плохие сюрпризы, которые я получаю, когда приложение переходит на стадию тестирования.

Cliffnotes: два документа, предназначенные для двух разных аудиторий. Один из них очень заинтересован техническими лакомыми кусочками, а другой не знает о технических лакомых кусочках. Не спешите, объясняйте вещи, делайте схемы и диаграммы (если вы уверены, что вы им хороши), читайте ваши документы снова и снова, и у вас будет прочная документация.

Редактировать: Word (или любой альтернативный текстовый процессор) обычно достаточно хорош, чтобы делать такие документы. Использование UML не всегда является хорошей идеей, особенно если вы не хорошо разбираетесь в UML (не стыдно в ней :).

Один маленький трюк Я считаю полезным: использование редактора веб-страниц WYSIWYG может помочь вам создать прототипы быстрых и грязных страниц, которые вы можете вставить в свои документы. Я даже зашел так же, как переустановить VB6 на старом компьютере, чтобы создать прототип прототипа для быстрого и грязного окон для этой цели. Он отлично работает и занимает очень мало времени.