Creating a specification document
We have written our system specification by fleshing out its behaviors as Scenario
s in our Feature
s. These can be seen by anyone who reads our feature files (.feature
). The trouble is that our feature files are located in our project directory, alongside our code (see Chapter 3, Writing Fantastic Features with the Gherkin Language, specifically the Knowing why Features are executable specifications section). As our code will usually live on a hosted version control repository, such as GitHub or GitLab, making it accessible to all stakeholders can be challenging. To make our specification visible to anyone who wants to read it, it is a good idea to create a specification document. This document should include the following:
- Revision history: The specification document is a living document. It constantly changes and evolves. If our documentation system doesn't support versioning, then a revision history table is a good way of seeing how...