DEV Community

loading...

Discussion on: The Bus Factor

Collapse
courier10pt profile image
Bob van Hoove • Edited

I think that README suggestion mostly stems from past annoyances with projects that make you figure it out all yourself :)

You mentioned your experience with wikis. I wonder, how did that work out? Was it well adopted? What sort of information would you put in there?

For one thing I like that it's hypertext.

Thread Thread
lukebearl profile image
Luke Bearl Author

Overall wikis have been good. We use the full Atlassian Suite so Confluence interops with everything else. The big problem is that the wiki isn't linked to the code at all, so things can change and people always forget to update. The only real solution we've found is to try and be vigilant about Documentation. Since we do code review on all branches it might make sense to try and have the reviewers also catch any documentation updates that are required.