Ask HN: How to generate product docs E2E?

2 pointsposted a day ago
by sarabande

Item id: 44483136

1 Comments

ok1984

a day ago

In my experience, If you want to auto-generate your documentation then most likely is not useful, documentation should explain concepts, domain knowledge, architectural decisions and much more that you can’t have fit as a one-to-one mapping with your code.

Also, writing documentation is athat moment that makes you think about your software from a different perspective, often times I discovered and refactored my code during the process of writing down documentation.

We use Antora and VSC to write down our documentation.