473,327 Members | 1,930 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,327 software developers and data experts.

What documentation processes to people use?

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.
Nov 16 '05 #1
2 1573
Hi

I use XML comments and NDoc utility (it's free) which generates MSDN-like
documentation.

"Peter Rilling" <pe***@nospam.rilling.net> wrote in message
news:ea**************@TK2MSFTNGP12.phx.gbl...
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.

Nov 16 '05 #2
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.
"Ivan G." <iv************@hotmail.com> wrote in message
news:eS**************@TK2MSFTNGP11.phx.gbl...
Hi

I use XML comments and NDoc utility (it's free) which generates MSDN-like
documentation.

"Peter Rilling" <pe***@nospam.rilling.net> wrote in message
news:ea**************@TK2MSFTNGP12.phx.gbl...
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.


Nov 16 '05 #3

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

54
by: Brandon J. Van Every | last post by:
I'm realizing I didn't frame my question well. What's ***TOTALLY COMPELLING*** about Ruby over Python? What makes you jump up in your chair and scream "Wow! Ruby has *that*? That is SO...
3
by: Chris Cioffi | last post by:
I started writing this list because I wanted to have definite points to base a comparison on and as the starting point of writing something myself. After looking around, I think it would be a...
121
by: typingcat | last post by:
First of all, I'm an Asian and I need to input Japanese, Korean and so on. I've tried many PHP IDEs today, but almost non of them supported Unicode (UTF-8) file. I've found that the only Unicode...
3
by: junior lopes | last post by:
i work with c# windows application, and i want to know how to do documentation? if i use UML or Flowchart or DFD ? if exists some site or book or same example to help. Thanks *** Sent via...
28
by: john_sips_tea | last post by:
Just tried Ruby over the past two days. I won't bore you with the reasons I didn't like it, however one thing really struck me about it that I think we (the Python community) can learn from. ...
669
by: Xah Lee | last post by:
in March, i posted a essay “What is Expressiveness in a Computer Language”, archived at: http://xahlee.org/perl-python/what_is_expresiveness.html I was informed then that there is a academic...
98
by: tjb | last post by:
I often see code like this: /// <summary> /// Removes a node. /// </summary> /// <param name="node">The node to remove.</param> public void RemoveNode(Node node) { <...> }
5
by: =?Utf-8?B?QnVkZHlXb3Jr?= | last post by:
Hello, My understanding is BizTalk 2006 is the rolls royce of Workflow where Framework 3.0 has some of the components. Is this true? Is there some documentation that shows the differences?...
167
by: darren | last post by:
Hi I have to write a multi-threaded program. I decided to take an OO approach to it. I had the idea to wrap up all of the thread functions in a mix-in class called Threadable. Then when an...
0
by: DolphinDB | last post by:
Tired of spending countless mintues downsampling your data? Look no further! In this article, youll learn how to efficiently downsample 6.48 billion high-frequency records to 61 million...
0
by: ryjfgjl | last post by:
ExcelToDatabase: batch import excel into database automatically...
1
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: Vimpel783 | last post by:
Hello! Guys, I found this code on the Internet, but I need to modify it a little. It works well, the problem is this: Data is sent from only one cell, in this case B5, but it is necessary that data...
1
by: PapaRatzi | last post by:
Hello, I am teaching myself MS Access forms design and Visual Basic. I've created a table to capture a list of Top 30 singles and forms to capture new entries. The final step is a form (unbound)...
1
by: Defcon1945 | last post by:
I'm trying to learn Python using Pycharm but import shutil doesn't work
1
by: Shllpp 09 | last post by:
If u are using a keypad phone, how do u turn on JavaScript, to access features like WhatsApp, Facebook, Instagram....
0
by: af34tf | last post by:
Hi Guys, I have a domain whose name is BytesLimited.com, and I want to sell it. Does anyone know about platforms that allow me to list my domain in auction for free. Thank you
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome former...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.