Ask HN: How to generate product docs E2E?

4 points by sarabande 315 days ago | 1 comment

I have an existing handwritten knowledgebase with screenshots of an app, a codebase with standard CI/CD pipelines, and an API whose docs are autogenerated against an OpenAPI spec.

Is there a convenient way these days to chain software together so that product documentation, including screenshots, is completely autogenerated on new codebase commits? Anyone tried some chain of tools, including paid ones, that works successfully in the wild?

ok1984 315 days 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.