Logo: Relish

  1. Sign in

Project: relish

Living Documentation

If your team practices Acceptance Test Driven Development (ATDD), Behaviour Driven Development (BDD) or Specification By Example, you'll be writing executable specifications, automated tests that read like documentation. This kind of documentation is always up to date, because it's run daily against the software to test it.

Relish provides a home for that living documentation. Rather developers keeping it locked away in their source code control repositories, you can publish it to Relish where the whole team can browse it, read it and search it.

Relish lets you mix pages of documentation pages made from executable Cucumber features, or plain old Markdown files. You can use a special .nav file to control the order in which pages are displayed in the left-hand navigation menu to give you more editorial control.

Last published over 7 years ago by mattwynne.