Что делает отличную функциональную спецификацию отличной?

Question

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

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

Answer 1

Project Aardvark specs от Joel on Software - лучшее, что я когда-либо встречал. Каждый экран определяется очень хорошо, с картинками. Описаны основные функции программного обеспечения, а также некоторые технические детали.

К сожалению, спецификации, которые я получил лично, не такие уж блестящие. Обычно это просто маркированный список функций, которые они ожидают от каждого раздела системы, и они ожидают, что вы проработаете все детали. Что хорошо, я думаю. Тем не менее, я пишу документ дизайна игры для RPG-игры, над которой я работаю как личный проект, и я думаю, что спецификации, которые я пишу, написаны очень хорошо. Я разделил игру на разделы, такие как

• Символы
• Оружие и броня
• Уровни
• Карта
• Физика

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

Я также настоятельно рекомендую прочитать Серия безболезненных функциональных спецификаций от Joel on Software для всех, кто интересуется написанием лучших спецификаций.

Answer 2

ИМХО, ключевым качеством должно быть то, что в функциональной спецификации очень подробно указано «что», а не «как». Таким образом, запросчик (маркетинг?) Получает тот внешний вид и набор функций, которые ему нужны, но реализация остается за теми, кто знает это лучше всего - разработчиками.

Answer 3

Очевидно, что спецификация должна быть полной, последовательной и понятной. ИМО также должна быть хорошо организована, так как в ней собраны все требования к определенной части продукта. Я не раз читал спецификации, где требования для какого-либо модуля были разбросаны по всему документу, например общее описание приведено в главе 4, но дополнительные требования можно найти в разделах в главах 2, 5, 7 и приложении B. Для работы с такой спецификацией мне сначала необходимо создать карту перекрестных ссылок требований к модулям.

Answer 4

В хорошей спецификации должно быть четко указано, что должно делать приложение.

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