this post was submitted on 03 Aug 2023
352 points (99.2% liked)
Programmer Humor
19548 readers
1064 users here now
Welcome to Programmer Humor!
This is a place where you can post jokes, memes, humor, etc. related to programming!
For sharing awful code theres also Programming Horror.
Rules
- Keep content in english
- No advertisements
- Posts must be related to programming or programmer topics
founded 1 year ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
Because things keep changing and no one ever updates any docs or guides.
It would be nice to have a kind of central hub where all the lastest resources are listed.
I could be updated by the community.
Well... one can dream.
If it's updated by the community, it's probably also created by the community. Instead of dreaming, why not create it?
Be the change you want to see in the world 🌈
Stack Overflow tried that with their documentation project
Someone should build a system that scrapes all open source repositories and uses an LLM to generate up to date documentation, and puts it in one big searchable place
If using docstrings/docblocks to generate SDK documentation, adding something like an OPA policy to validate their existence and semantic structure could help with coverage. Then we have the issue of accuracy, and that needs humans or AI to weigh in. I have a feeling test-driven development would make this process smoother.
You could also add git hooks to facilitate accountability / run the policies.