How to add documentation to your product life cycle

• homechart

  17 142 7.4 TypeScript

  A web platform for managing households

  

• diaspora*

  89 13,344 7.9 Ruby

  A privacy-aware, distributed, open source social network.

  

What are your thoughts on BDD and Gherkin test scripts? The federated Diaspora* app has a BDD test suite [0], and for the Fediverse people are test-driving if it is applicable for ActivityPub compliance testing [1].

[0] https://github.com/diaspora/diaspora/tree/develop/features

[1] https://codeberg.org/helge/fediverse-features

• InfluxDB

  www.influxdata.com sponsored

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

• hitchstory

  23 83 9.1 Python

  Type-safe YAML integration tests. Tests that write your docs. Tests that rewrite themselves.

  

I don't like gherkin. It's it has very awkward syntax, it's not type safe, it's very verbose, it has no ability to abstract scenarios and rather than being a source for generating the documentation it tries to be the documentation.

Nonetheless, there is a small number of projects where they either work around this or it doesn't matter as much. I find that most people that apply gherkin to their projects find it doesn't work - usually for one of the above reasons.

I built https://github.com/hitchdev/hitchstory as an alternative that has straightforward syntax (YAML), very strict type safety (StrictYAML), low verbosity, and is explicitly designed as a source for generating documentation rather than trying to be the documentation.

Suggest a related project