This is mostly an unsolved problem. People use everything from github wikis to hosted services like quip and google docs. The fundamental problem is that different people want to know different things and the textual format is a very rough first-order approximation of what each person would like to know.
So really as long as you pick something and are consistent it won't make much difference because all reasonable solutions are equally good.
Yeah, I've found that we're gradually getting better at this, but it's hard to just tell others to get on our system because you can't really skip steps. It kind of evolved naturally to fit our style.
And we still have a long way to go, but I feel like we're improving by combining an emphasis on good habits with a realism that good habits are hard to build.
We're a place where coders share, stay up-to-date and grow their careers.
We strive for transparency and don't collect excess data.