Solved

Software Documentation

Posted on 2008-10-02
2
303 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
[X]
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions
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

Free Tool: SSL Checker

Scans your site and returns information about your SSL implementation and certificate. Helpful for debugging and validating your SSL configuration.

One of a set of tools we are providing to everyone as a way of saying thank you for being a part of the community.

Question has a verified solution.

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

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 …
This article shows how to deploy dynamic backgrounds to computers depending on the aspect ratio of display
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 seventh video of the Xpdf series, we discuss and demonstrate the PDFfonts utility, which lists all the fonts used in a PDF file. It does this via a command line interface, making it suitable for use in programs, scripts, batch files — any pl…

695 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