В чем разница между техническими характеристиками и проектной документацией?

38

Каковы технические характеристики? Являются ли они такими же, как проектные документы. Если нет, то в чем разница и некоторые примеры?

documentation specifications Джон V
источник
1
Первый скучает по дизайну, а второй по техническим причинам.

Ответы:

33

Документ разработки программного обеспечения может быть на уровне системы или компонента и обычно включает в себя:

  • соответствующие цели или требования (функциональные и нефункциональные);
  • статическая структура (например, компоненты, интерфейсы, зависимости);
  • динамическое поведение (как компоненты взаимодействуют);
  • модели данных или внешние интерфейсы (внешние по отношению к системе / компоненту, описанным в документе); а также
  • соображения развертывания (например, требования времени выполнения, сторонние компоненты).

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

Техническая спецификация описывает минутную деталь либо все , либо конкретные части конструкции, такие , как:

  • подпись интерфейса, включая все требуемые типы данных / структуры (входные типы данных, выходные типы данных, исключения);
  • подробные модели классов, включая все методы, атрибуты, зависимости и ассоциации;
  • конкретные алгоритмы, которые использует компонент и как они работают; а также
  • физические модели данных, включая атрибуты и типы каждого объекта / типа данных.
miraculixx
источник
1
Итак, когда мы должны написать техническую спецификацию? До разработки? Наряду с развитием? или после ..?
shashwat
2
@ShashwatTripathi, как правило, спецификации пишутся до разработки, чтобы кто-то другой (или вы позже) могли реализовать компоненты. Написание спецификации после завершения разработки делает ее бессмысленной (если вы не используете ее в качестве технической документации о том, что было реализовано).
miraculixx
Я сталкивался с этим точным сценарием, работая на огромную корпорацию над многолетним проектом. Мы работали в обратном направлении, создавая документ бизнес-требований после переноса проекта в Test, а затем в Prod! Да, отличное управление проектами, я знаю!
ThinkCode
Разве технические спецификации не создаются после того, как детали функционально разложены в Спецификацию требований к программному обеспечению? Как архитектор может создать TS без SRS? Похоже, он / она должен будет принять тонну.
Оракулярный мужчина
Согласитесь, TS должен следовать SRS (спецификация системных требований). Однако обратите внимание, что эти термины не стандартизированы, и TS может быть создан либо как подробная форма SRS (типичная для встроенных систем), либо может использоваться для дополнения SRS высокого уровня, то есть проектного документа (типично в коммерческих приложениях). ). Ключевым моментом является то, что требования, проектная документация и спецификации описывают один конкретный взгляд на систему и ее компоненты. Более важно, чтобы команда согласилась с необходимыми точками зрения и уровнем детализации, чем с соблюдением какого-то формального определения.
miraculixx
7

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

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

tdammers
источник
Спасибо. Также в основном мне нужна функциональная спецификация, чтобы знать, что делать, а затем разрабатывать документы, чтобы знать, как это сделать, это правильно? Просто маленький вопрос, на какой функциональный дизайн вы ссылались (надеюсь, это не добавит путаницы в мое понимание функциональной спецификации)
Джон V
Функциональный дизайн определяет предполагаемую функциональность продукта с точки зрения пользователя, не вдаваясь в подробности реализации. Здесь есть множество вопросов с отличными ответами, которые дают исчерпывающее объяснение того, что такое функциональный дизайн, а что нет.
tdammers
1
Итак, когда мы должны написать техническую спецификацию? До разработки? Наряду с развитием? или после ..?
shashwat