Hacker News Reader

For those interested in the concept of having guaranteed/permanently up-to-date documentation (with or without screenshots) I built this testing framework based upon autogenerating good how-to or reference docs from tests:

https://github.com/hitchdev/hitchstory

(the website example has screenshots generated by playwright, the REST API example has real tested JSON snippets, the command line example has command outputs, etc.)

View on HN

For those who want to do it manually, just give every screenshot a number, and put comments in the code saying "This UI layout / function affects Figures 1, 2, 4, 7". If you don't trust your team to maintain a sequence (fair) use random numbers.

This also helps when people want to refer to a particular screenshot, and it can double as anchor IDs in an HTML page.

Exactly what I was hoping to find in the comments. Thank you

Reply on news.ycombinator.com