Solved

Software Documentation

Posted on 2008-10-02
2
267 Views
Last Modified: 2010-10-05
Continue from http://www.experts-exchange.com/Programming/Misc/Q_23780237.html#a22621802.

I would like to zoom in to the technical documention aspect of software documentation.
What is the best approach to document the software since I have only the source code to refer to at this moment?
0
Comment
Question by:sepknow
2 Comments
 
LVL 55

Accepted Solution

by:
Jaime Olivares earned 250 total points
ID: 22630059
you can do reverse engineering to generate UML diagrams (class, packages, activity, etc.) from the source code.
You can do it with Visual Studio Team Edt. and Visio, or you can use some 3rd party tool like IBM's Rational reverse engineering tools.
 
0
 
LVL 11

Assisted Solution

by:PlatoConsultant
PlatoConsultant earned 250 total points
ID: 22631312
i have seen a tool    "Understand " from SCItool it  is a tool to understand software documentation...
sci understand is an easy to use tool to understand complex source code and generating documentation from different source code it supports all the languages.

above mentioned tools made UML models for understanding classes and their hierarchy they do not show the actual sequence flow.
 
http://www.scitools.com/products/understand/

The swiss army knife of tools for source navigation, code understanding and static analysis - useful for every practicing software engineer. Fast and easy to use, it is a programmers IDE oriented at maintenance tasks. It supports C/C++/C# and Java
0

Featured Post

DevOps Toolchain Recommendations

Read this Gartner Research Note and discover how your IT organization can automate and optimize DevOps processes using a toolchain architecture.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

Suggested Solutions

Title # Comments Views Activity
Stream.BeginRead and Stream.EndRead in .NET Core 5 35
Runtime Error 2 28
User Authentication using Digital Certificate 2 20
Close form "before" open 3 19
If you’re thinking to yourself “That description sounds a lot like two people doing the work that one could accomplish,” you’re not alone.
Although it can be difficult to imagine, someday your child will have a career of his or her own. He or she will likely start a family, buy a home and start having their own children. So, while being a kid is still extremely important, it’s also …
Viewers will learn how to properly install Eclipse with the necessary JDK, and will take a look at an introductory Java program. Download Eclipse installation zip file: Extract files from zip file: Download and install JDK 8: Open Eclipse and …
In this fourth video of the Xpdf series, we discuss and demonstrate the PDFinfo utility, which retrieves the contents of a PDF's Info Dictionary, as well as some other information, including the page count. We show how to isolate the page count in a…

914 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question

Need Help in Real-Time?

Connect with top rated Experts

20 Experts available now in Live!

Get 1:1 Help Now