Какие качества сделали его настолько отличным, и что отличает его по сравнению с не очень большими характеристиками, с которыми вам приходилось иметь дело? Или, если вы никогда раньше не работали с хорошей функциональной спецификацией, что бы вы ожидали в отличной спецификации?
Извините, это явно субъективно, но я создаю функциональную спецификацию (а не мою первую), и мне просто пришло в голову, что я могу получить хорошие идеи от ярких людей на SO!
Характеристики проекта Aardvark от Joel on Software - лучшее, что я до сих пор встречал. Каждый экран определен очень хорошо, с изображениями. Описаны основные функции программного обеспечения, а также некоторые технические детали.
К сожалению, характеристики, которые я получил лично, не настолько блестящи. Обычно это всего лишь маркированный список функций, которые они ожидают от каждого раздела системы, и они ожидают, что вы будете обрабатывать все детали. Кажется, это прекрасно. Тем не менее, я пишу документ дизайна игры для игры RPG, над которой я работаю как персональный проект, и я думаю, что спецификации, которые я пишу, очень хорошо написаны. Я разделил игру на разделы, такие как
и т.д., и описал каждый раздел в терминах игрового процесса, а также некоторые технические детали. Его очень легко работать.
Я также настоятельно рекомендую прочитать "Бесценные функциональные спецификации" от Joel on Software для всех, кто заинтересован в написании лучших спецификаций.
IMHO, ключевым качеством должно быть то, что функциональная спецификация специфицирует "что" в деталях, но не "как". Таким образом, запросчик (маркетинг?) Получает внешний вид и набор функций, которые они хотят, но реализация предоставляется тем, кто знает это лучше всего - разработчикам.
Очевидно, что спецификация должна быть полной, последовательной и понятной. ИМО также должна быть хорошо организована, поскольку она сохраняет все требования к определенной части продукта вместе. Я не раз читал спецификации, где требования к некоторому модулю были разбросаны по всему документу, например. общее описание приведено в главе 4, но дополнительные требования могут быть найдены в статьях в главах 2, 5, 7 и приложении B. Чтобы работать с такой спецификацией, мне сначала нужно создать карту перекрестных ссылок требований к модулям.
Хорошая спецификация должна указывать, что приложение должно делать, в ясной форме.
Это кажется очевидным, но материал, который я обычно получаю, часто очень расплывчатый. По-видимому, людям не очень легко выразить то, что они хотят на бумаге, если они даже знают, чего они хотят.