Sure, you can get technical writers to do it for you if you have a big team, but a lot of small, open source projects suffer from the lack of proper documentation.
Sure, you can get technical writers to do it for you if you have a big team, but a lot of small, open source projects suffer from the lack of proper documentation.
- near nothing, good luck
- debian, ultra structured, .. hard to digest / boring
- gentoo / arch, barely structured, just enough content to get the gist, yet precise, and a lot more tips for funsies.
this is an art
I particularly like that if I have an issue, and I figure it out, I can just pop a quick line in there. h4:"Issues snafucating while running nvidia proprietary driver". Body: "you get this error message. <snip>. This is due to <snip>. Run this command to fix it." And it's already at the quality that people expect.
Software is often documented as if it was a integral part of the program, but it's wrong on the human level I believe.
Good documentation also needs ‘testing’ by someone who is not already familiar with the content.