Архивирование сценариев и переиздание рассказов

Question

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

Когда мы обсуждаем проблемы с существующей функцией, трудно понять, что мы уже сделали, и было бы трудно оглянуться назад с помощью инструмента схватки, такого как TFS. У нас есть несколько тестов, но они не видны владельцу продукта.
Должны ли мы искать какой-то обширный список сюжетов/сценариев, изменяя/обновляя по мере того, как мы идем, или это не ловко.

У нас нет записей о том, как работает программное обеспечение, кроме кода, некоторых модульных тестов, некоторых тестовых примеров и нескольких устаревших руководств.

Answer 1

Мы склонны использовать наши автоматические приемочные испытания для документирования этого. Когда мы работаем над пользовательской историей, мы также разрабатываем автоматизированные тесты, и это часть нашего определения Done.

Мы используем SpecFlow для тестов, и они записываются как сценарии With, When, Then, которые легко читаются и понимаются и могут быть доступны владельцам продуктов.

Эти тесты приносят большую ценность, поскольку они являются нашим автоматизированным набором регрессии, поэтому регрессионное тестирование выполняется быстрее и проще, но поскольку они постоянно обновляются в процессе разработки новых историй, они также служат документацией о том, как работает система ,

Возможно, вам будет полезно ознакомиться с несколькими блогами в разделе «Спецификация по примеру», который по сути является тем, что мы пытаемся сделать.

Несколько ссылок, которые я нашел полезным в прошлом, являются:

http://www.thoughtworks.com/insights/blog/specification-example

http://martinfowler.com/bliki/SpecificationByExample.html

Answer 2

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

Answer 3

Поскольку вы хотите иметь возможность сопоставить описание того, что вы сделали с работающим программным обеспечением, тогда это звучит так, как будто вы должны использовать это в управлении версиями вместе с программным обеспечением. Начните с каталога docs /, затем добавьте детали по мере необходимости. Я делаю это часто, и это просто работает. Если вы хотите сделать этот веб-сервис, а затем настройте веб-сервер где-нибудь, чтобы проверять документы так часто и указывать корень документа в рабочей папке docs /.