My<cod/>.net
Как написать спецификацию, которая является продуктивной?
Я видел, как разные менеджеры программ пишут спецификации в разных форматах. Почти у каждого был свой собственный стиль написания спецификации.
С одной стороны, те многословные документы, которые даны программисту, вероятно, заставят его/ее пропустить несколько вещей. Я лично боюсь документов word spec...I думаю, что это из-за моего чтения style...I я всегда быстро читаю вещи, которые, как я думаю, заставят меня пропустить ключевые моменты.
С другой стороны, я видел эти инновационные спецификации, написанные в Excel одним из наших клиентов. То, как он писал спецификацию, было своего рода созданием макетного приложения в Excel и использованием некоторого VBA, чтобы издеваться над ним. Он будет делать такие вещи, как при нажатии кнопки, куда должна идти форма или какое действие она должна выполнять (в комментариях).
В форме данных он будет отображать форму в ячейках, и в каждой ячейке ввода данных он будет комментировать, какие допустимые значения, какая проверка должна выполняться и т. д.
Я думаю, что, используя эту технику, было меньше шансов упустить то, что нужно было сделать. Кроме того, это было намного проще для модульного тестирования его для разработчика. Тестировщик тоже лучше понимал систему, поскольку она 'performed' до того, как была написана.
Visio-это еще один инструмент для создания дизайна экрана, но я все еще думаю, что Excel имеет лучшее преимущество над ним, учитывая его поддержку VBA и его функции.
Как вы думаете, это должно стать более популярным способом написания спецификации? Я знаю, что это включает в себя немного дополнительной работы со стороны менеджера проекта(или того, кто пишет спецификацию), но выигрыш в том, что huge...I сам мог бы увидеть большой прирост производительности от его использования. И если есть какие-то лучшие форматы спецификаций, которые действительно помогут программисту.
Два подхода хорошо сработали для меня.
Один из них-это "working prototype", который вы вроде как описали в своем вопросе. По моему опыту, компания заключила контракт с экспертом по пользовательскому интерфейсу для создания полнофункциональных HTML mocks. Данные на странице были статичными, но это позволяло разработчикам и руководству видеть и играть с версией сайта "functional". Все, что осталось сделать, это заменить статические данные на страницах динамическим контентом - этот прототип был нашей спецификацией для начальной версии нашего продукта. Дизайнер даже включил подробное объяснение некоторого тонкого поведения во всплывающих диалогах, которые будут появляться при наведении указателя мыши на фиктивные ссылки. Это хорошо сработало для нашей команды.
В последующем проекте у нас не было роскоши эксперта UI, но мы использовали аналогичный подход. Мы использовали wiki, чтобы издеваться над версией сайта. Мы создали связи между функциональными аспектами системы и подробно документировали каждый элемент функциональности. Каждая часть функциональности, в свою очередь, может быть связана с детальным проектированием и архитектурными решениями. Мы также использовали wiki для хранения списка функций to list для каждого выпуска (который стал нашим примечанием к выпуску). Эти документы связаны со страницей подробных функций. wiki стал живым документом, описывающим наши релизы и эволюцию нашей системы в мельчайших деталях. Это был бесценный ресурс.
Я предпочитаю wiki рабочему прототипу, потому что он более легко расширяется - растет и становится более ценным по мере развития вашей системы.
Я думаю, что вы можете взглянуть на тестовые требования, которые являются методом создания исполняемых спецификаций.
Есть некоторые большие инструменты, такие как FIT , Fitnesse , GreenPepper или Concordion для этой цели.
В одной из книг Microsoft Press есть отличные примеры различных документов, в том числе SRS (о чем, я думаю, вы говорите). Это может быть одна из книг требований Weigert (я думаю, что это его имя, я сейчас закрываю его). Я видел, как US правительственных организаций используют это в качестве шаблона, и из моего опыта работы с правительством они любят создавать свои собственные, где бы они ни могли, поэтому, если они повторно используют его, это должно быть хорошо.
Кроме того-спецификация не должна содержать кода, на мой взгляд. Он должен сосредоточиться на том, что система должна делать, должна делать и не может делать с помощью текста и диаграмм.