4 ms·
How do you handle readmes getting out of date? I started a new project with a colleague and we wrote a nearly 1000 line Markdown readme with code examples of be
by mssundaram 6y ago
How do you handle readmes getting out of date? I started a new project with a colleague and we wrote a nearly 1000 line Markdown readme with code examples of best practices, patterns etc before we brought on 4 other engineers to the team (who were new to the company). But it quickly became old and out of date as we worked through the project.
So more specifically, I know that one strategy is to just make time to keep it up to date, but I do think there is more to it than that. One aspect was out of date code examples - referring to old line numbers or old patterns that we reconsidered. I think some of that could be automated, and it made me wish for or wonder something better.
- soylentgraham 6y agoHow did the readme get out of date... Did the API change from the spec of the readme? Shouldn't the readme change first, so its always the code that's out of date? :)
- mssundaram 6y agoHah! I see, I missed the point
- samus 6y agoIs there some develeper churn on the project? If yes, they would be perfect test drivers for the readme. If they get lost, there is a problem with your readme, or with your code. Likely both. You also have a developer readme, right? ;-)