concept documentation system in category software development

appears as: documentation system
Writing Great Specifications: Using Specification by Example and Gherkin

This is an excerpt from Manning's book Writing Great Specifications: Using Specification by Example and Gherkin.

In order to help you write specifications like this, the upcoming chapters will apply SBE’s key process patterns to Gherkin. You’ll be able to offer programmers, designers, and managers an inclusive environment for clear communication, discovering requirements, and building a documentation system.

Building and evolving a documentation system is the last step in the life cycle of any executable specification. Your work on a specification is rarely finished after you deploy the new feature to production. You’ll likely come back to rewrite the steps, or change the structure of the scenarios, or, as in the case we just discussed, add clarifications to the specification layer. Chapter 7 goes into depth on these topics.

Specification by Example: How Successful Teams Deliver the Right Software

This is an excerpt from Manning's book Specification by Example: How Successful Teams Deliver the Right Software.

When the entire user story is implemented, someone will first validate that it’s done and then restructure the specifications so that they fit in with the specifications for features that were already implemented. They’ll use the practices from chapter 11 to evolve a documentation system from the specifications in increments. For example, they might move the specification for free delivery into the hierarchy of features related to delivery, potentially merging them with other free-delivery examples triggered by different factors. In order to make the documentation easier to access, they might set up links between the specification for free delivery and the specifications for other delivery types.

Evolving the ubiquitous language around the activities of user personas allows us to ensure that our understanding of what individual personas need is aligned with how they use the system. This drives the structure and language used in specifications and helps us make the documentation system consistent.