Developers, I need your opinion!
So I'm a developer and naturally I come across a few annoyances/problems here and there with my everyday job.
The largest thing that is bothering me at the moment is how stale our internal README has become. This purpose of the internal README(s) is to contain information from how to set up a dev machine locally to how to deploy to production.
I believe we often start with good intentions but overtime it inevitably becomes outdated with tech changing and software evolving. Also no one really wants to touch it, it always gets put to the bottom of the list.
I would like to solve this problem.
If you also see this problem I would greatly appreciate if you filled out my Google Form so that I can work out a way to solve it and whether it's a problem others face too - https://goo.gl/forms/SUE42oDtslBEH0Lb2
I'd also love to hear your thoughts!
Thanks.
If you're in London on Wednesday you should definitely consider coming to IndieBeers, it's honestly great to meet like minded Indie Hackers. Beer too! :)
Done
Thank you!
I see it as a problem. Whats your solution? An interactive README.md that is source-code aware so that code changes require applicable README updates?
I don't currently have a single solution, hence the survey. From the responses so far it would seem that people prefer the idea of "continuous documentation". As you mention, one idea may be to have a README tied to specific code changes.
Done! I must say, this is a really difficult problem to solve, many companies have tried. It would be really great if you could solve it!