DEV Community

Discussion on: Use Cases As Documentation

Collapse
 
patricktingen profile image
Patrick Tingen

Interesting idea. I have a project on GitHub as well and often observer new users of my project while starting to work on it (very informative, I can tell). New users - just like myself - don't read a manual, but instead start using the product.

When encountering a problem, it is early enough to start finding a manual. But even then you don't want to have a set of linked pages enumerating all the features. Instead, you will want to jump to the page that describes the solution to your problem. Having the documentation use-case-based sounds like a good way to facilitate this.