Шаблоны и примеры SDD (Software Design Document)




В теме 8 ответов, и 4 участника, последнее обновление сделано пользователем Аватар (Belle Morte) Belle Morte 6 г, 4 мес. назад.

Показано 9 ответов - от 1 до 9 (всего 9)
  • Автор
    Сообщения
  • 21.03.2010 в 02:48 # 5784
    Всех приветствую!

    Прошу поделиться в этой ветке примерами и шаблонами такой документации как Software Design Document.
    Для аналитиков это все же не очень обычный документ, но зачастую вероятно приходится (как людям, умеющим писать на иностранных языках и формализовывать хаотичные потоки сознания ) их составлять (при участии разработчиков и архитекторов), конечно. Учитывая, что на этом форуме крутятся и техрайтеры, то вероятно они смогут поделиться оным.

    Вот определение из Википедии для тех, кто как и я, знакомы с этим документом лишь понаслышке:

    A software design document (SDD) is a written description of a software product, that a software designer writes in order to give a software development team an overall guidance of the architecture of the software project. An SDD usually accompanies an architecture diagram with pointers to detailed feature specifications of smaller pieces of the design. Practically, a design document is required to coordinate a large team under a single vision. A design document needs to be a stable reference, outlining all parts of the software and how they will work. The document is commanded to give a fairly complete description, while maintaining a high-level view of the software.

    There are two kinds of design documents called HLDD (High Level Design Document) and LLDD (Low Level Design Document).

    Буду очень признателен реальным примерам.

    Поделиться:

    Цитировать

    25.03.2010 в 12:16 # 5785
    Аватар (Belle Morte)
    Belle Morte
    Админ
    Пожалуй я начну: примера у меня под рукой не оказалось, но нашла неплохой, на мой взгляд, шаблон. Это для начала, чтобы было, что обсудить, в дальнейшем, надеюсь, кто-нибудь поделится собственным опытом в составлении таких документов.
    Поделиться:

    Благодарностей: 1   Цитировать

    25.10.2010 в 12:56 # 5786
    Аватар (Snowball)
    Snowball
    Подписчик
    Всем привет…
    Пока ездили в командировку, связанную с проектом, было время в дороге подумать о высоком )).
    Вот выкладываю 2 обнаруженных в сети довольно разных варианта SDD и тут же хочу задать вопрос.

    А в чем все-таки соль этого документа… Почему нельзя было создать такой стандарт, который бы объединял данный документ со спецификацией требований?
    Ведь сказано — не плодите сущностей без необходимости…

    Вот в русскоязычном стандарте все объединено в техпроект:
    один раздел — описание процессов (прослеживается аналогия с функциональными требованиями SRS)
    другой — описание основных технических решений (прослеживается аналогия с SDD)

    А тут… Вопрос мой, наверное, следует пометить тегом "глупый" :)

    Поделиться:

    Цитировать

    25.10.2010 в 13:24 # 5787
    Хороший вопрос :) . С моей точки зрения не стоит мешать эти документы хотя бы потому, что разные люди работают над ними. Мне бы не понравилось, если бы архитекторы/разработчики лезли и правили мою документацию. Это во-первых. Во-вторых, SRS можно и заказчику послать почитать, не такой уж и скучный документ… А вот были бы в нем еще code conventions, архитектура классов и т.д. — он бы повесился. В-третьих — ну а зачем? Количество проектной документации снизить? Не тот value, чтобы заставлять всех, кроме требований, читать aka пролистывать еще и ненужные детали реализации.
    Поделиться:

    Цитировать

    25.10.2010 в 17:22 # 5788
    Аватар (Snowball)
    Snowball
    Подписчик
    Спасибо. Исчерпывающий и очень полезный для меня ответ! Единственная поправка на наши местные условия: нам не полагается системного архитектора. Его роль выполняет главный инженер проекта, но он ничего не пишет.. Он только руководит процессом разработки, а пишут всё 2 аналитика, один из которых me )))
    Поэтому мы экономим на писанине. Понимаю, что это, вероятно, не есть хорошо.. Но таковы реалии. Не всем посчастливилось работать в масштабных проектах и как по учебнику *WRITE*
    Поделиться:

    Цитировать

    25.10.2010 в 18:03 # 5789
    Поэтому мы экономим на писанине. Понимаю, что это, вероятно, не есть хорошо..

    Ну, собственно, а чем плохо? :) У вас есть конкретное пожелание заказчика увидеть SDD?
    Признаюсь, практически ни на одном проекте, в котором я участвовал, мы не писали SDD. Да Это, кстати, отдельный вопрос — нужен ли данный документ и если да, то когда? Если вкратце, то на мой взгляд если проект на является какой-то мегагромадной многолетней системой + на проекте некому такой документ писать, то ну его в баню… Видов проектной документации много (если по учебникам). Да только если писать ее всю от начала и до конца смертеподобно.

    Поделиться:

    Цитировать

    19.04.2011 в 17:40 # 5790
    Аватар (Андрей В.)
    Андрей В.
    Подписчик
    Добрый день!
    Тоже заинтересовал SDD. :-)

    SDD как я понимаю должен писать архитектор основываясь на SRS?

    А как часто вам приходится писать SDD?

    Поделиться:

    Цитировать

    19.04.2011 в 17:44 # 5791
    Аватар (Андрей В.)
    Андрей В.
    Подписчик

    Всем привет…
    Вот выкладываю 2 обнаруженных в сети довольно разных варианта SDD и тут же хочу задать вопрос.

    один из них сверхсекретный SDD мин. обороны потенциального противника :) *THUMBS UP*

    Поделиться:

    Цитировать

    20.04.2011 в 10:53 # 5792
    Аватар (Belle Morte)
    Belle Morte
    Админ

    SDD как я понимаю должен писать архитектор основываясь на SRS?
    А как часто вам приходится писать SDD?

    Правильно понимаете, SDD, как правило, пишут архитекторы, однако они могут привлекать к процессу аналитиков, как сказал Герыч, "как людей, умеющих писать на иностранных языках и формализовывать хаотичные потоки сознания". Самостоятельно SDD мне писать не приходилось, а вот помогать рисовать диаграммы и приводить в порядок текст — бывало.

    Поделиться:

    Цитировать

Показано 9 ответов - от 1 до 9 (всего 9)

Вы должны авторизироваться для ответа в этой теме.