Documentation Best Practices #10
Description
I would like to talk about best practices for developing/managing
documentation efforts for an open source project. Many people seem to
believe that a wiki is the end-all-be-all best/only solution. I think that
a wiki can have its place, but I would also like to hear issues such as
including documentation in-line with the code and producing hard copy docs.
The big issue I'd like to hear talked about is the best way to produce it -
from the process/people to the tool chain and production. I think it would
be best to be able to keep documentation in DocBook format inside of the
svn repository with the rest of the code, but I can't seem to find and high
quality and free tools to work with it which seems to raise the barrier to
contribution fairly high. Quality documentation is hard to get in the first
place, so I want to keep the barriers as low as possible and still keep a
high level of quality (no spam)
Original issue reported on code.google.com by ryanecr...@gmail.com on 23 Jan 2008 at 2:44