06-07-2010 12:52 PM
Hi,
Our team will be submitting/giving a code to our client in a few weeks. Our clients wants to have a documentation of the code so that he may understand the code and make additions/modifications in the future. The documentation he desires is of the type which is normally given when a software project in different languages is completed.
Can someone please give so feedback as to how documentation report/document is to be made and what are the guidelines to be followed? If someone can give a documentation theyhave already done for their clients for reference, that will be great.
06-07-2010 01:42 PM
cs_BOT wrote:Hi,
Our team will be submitting/giving a code to our client in a few weeks. Our clients wants to have a documentation of the code so that he may understand the code and make additions/modifications in the future. The documentation he desires is of the type which is normally given when a software project in different languages is completed.
I assume you're referring to text-based languages. What do you mean by documentation? And what do you mean by "normally given"? Normal with respect to what this client usually gets, or more general? If the source code is what they're used to getting, well, that's certainly not going to happen the same way since there is no text-based equivalent. From LabVIEW you can print the source code using the File -> Print menu item and then selecting VI Documentation. However, usually what people want to see is documentation of algorithms, and that's usually done in other ways, such as state charts/diagrams, or even perhaps UML.
If you do a search for project documentation you will see that this has been discusses before.