#language-agnostic #architecture
Вопрос:
Большинство, если не все документы по архитектуре, которые я видел (и разработал), Были представлены в виде серии представлений (логических, физических, вариантов использования и т. Д.). Это предпочтительная планировка? Какие еще существуют стили?
Ответ №1:
Поскольку это сложно, трудно поступить иначе.
Я хотел бы начать с краткого изложения общих требований в одном абзаце. Если нет резюме в один абзац, это-возможно-самая важная вещь, которую нужно создать.
Как только краткое изложение будет закончено, появится обзор архитектурных особенностей. И после этого никто не прочтет ни единого слова.
Это не роман. Там нет сюжетной дуги. Никакой драмы. Никакого конфликта. Никаких персонажей. По крайней мере, я не могу найти способ сделать архитектуру читаемой.
Лучшее, на что вы можете надеяться, — это справочная работа с достаточным количеством индексов, перекрестных ссылок, обзоров и боковых панелей, чтобы люди ею пользовались.
Действительно, главное-это выходы. Картинка-это все, что кто-либо когда-либо будет использовать. И они будут помещены в PPT для внутренней и внешней презентации.
Так что не тратьте много времени на написание. Тратьте время на обзоры, сводки, списки функций и фотографии, которые люди хотят использовать каждый день.
Ответ №2:
Это может быть далеко от темы, но есть ли в любом случае возможность использовать идеи Джоэла о том, как сделать спецификации «забавными», пригодными для использования в этой области?
Комментарии:
1. Нет, это не отклоняется от темы, ИМО. Однако это тоже не помогает. Когда архитектура-это куча картинок, вы почти достигли многих целей Джоэла.
2. Юмор в описаниях был той частью, о которой я думал. Если вы можете сделать текст несколько приятным для чтения, он может быть гораздо более полезным.