Re:Ask HN: Is document discovery and staleness a challenge f...
by eternityforest on Friday November 18, 2022 @12:12AM
(#33650640)
I'm used to a lot of "Documents" being in the chat history on small projects. In practice it works perfectly fine, I can search. It's a bit scary though, if they disappear there could be a problem.
It's easy and frictionless to write, and I actually don't mind at all. I would be pretty much fine with a document system that started with a group chat like experience and added a bit more structure on top of that.
But really, more things could be self documenting. There doesn't need to be a document that says "This is the testing server and it is running this OS and has this IP", that kind of thing could probably be largely automated.
Code doesn't always need documentation, if you stop reinventing wheels and developing custom internal build tools. I don't need much documentation to run a Svelte project from github, the documentation is implicit in the fact you used an opinionated tool exactly as it was meant to be used.
It would be interesting to have a meeting, go over all recently used documentation, and figure out what it would take to automate it, and why it was needed.
It's easy and frictionless to write, and I actually don't mind at all. I would be pretty much fine with a document system that started with a group chat like experience and added a bit more structure on top of that.
But really, more things could be self documenting. There doesn't need to be a document that says "This is the testing server and it is running this OS and has this IP", that kind of thing could probably be largely automated.
Code doesn't always need documentation, if you stop reinventing wheels and developing custom internal build tools. I don't need much documentation to run a Svelte project from github, the documentation is implicit in the fact you used an opinionated tool exactly as it was meant to be used.
It would be interesting to have a meeting, go over all recently used documentation, and figure out what it would take to automate it, and why it was needed.