Remix.run Logo
OutOfHere 3 days ago

In all the companies I have worked at and have looked at such docs, unfortunately this doesn't really work because those internal documentation sites are statistically never up to date or even close. They are hilariously unclearly written or out of date.

As for relying on the code base, that is good for code, although not for onboarding/deployment/operations/monitoring/troubleshooting that have manual steps.

devstein 2 days ago | parent [-]

^this, but many non-code documents with manual steps can also be kept up-to-date as long as there is a way (a) relate it back to the codebase or another source of truth (b) detect conflicts (when someone says something in contradiction to an existing document)

Disclaimer: We are building this at https://dosu.dev