Как еще можно представить архитектурный документ помимо серии представлений? - PullRequest
3 голосов
/ 07 октября 2008

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

Ответы [ 2 ]

2 голосов
/ 07 октября 2008

Так как это сложно, трудно сделать иначе.

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

После того, как сводка будет удалена, появится обзор архитектурных особенностей. И после этого никто не прочитает ни единого слова.

Это не роман. Там нет сюжетной арки. Без драмы. Нет конфликта Нет персонажей. По крайней мере, я не могу найти способ сделать архитектуру читабельной.

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

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

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

0 голосов
/ 07 октября 2008

Это может быть ПУТЬ не по теме, но есть ли в любом случае возможность использовать Идеи Джоэла о том, чтобы сделать спецификации "забавными" пригодна ли эта сфера для использования?

...