What documentation processes to people use?

  • Thread starter Thread starter Peter Rilling
  • Start date Start date
P

Peter Rilling

I am trying to improve the documentation process at the company I work for.
I would like to ask how others have their process. I have discovered the
DocBook schema, but am wondering if there are other processes that people
use. What tools and schemas are .NET compatible that might be able to be
plugged into our automated build system to improve our process.
 
Hi

I use XML comments and NDoc utility (it's free) which generates MSDN-like
documentation.
 
Right, and we use that to, but those are only part of the documentation.
What about chapters about system architecture, UI design, etc. Also, the
developer comments do not help when in the architecture and design phase
because no code actually exists to comment.

For instance, DocBook is a schema not centered around the API. That way you
could specify an entire document in XML and just apply a transform. Change
the XSLT to conform to a new format and you change the way the specification
looks.
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Back
Top