Solved

Software Documentation

Posted on 2008-10-02
2
298 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

Forrester Webinar: xMatters Delivers 261% ROI

Guest speaker Dean Davison, Forrester Principal Consultant, explains how a Fortune 500 communication company using xMatters found these results: Achieved a 261% ROI, Experienced $753,280 in net present value benefits over 3 years and Reduced MTTR by 91% for tier 1 incidents.

Question has a verified solution.

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

Suggested Solutions

Title # Comments Views Activity
print bytes of an integer 6 46
c#, datatable, aspx 4 45
Oracle programming for starter 14 70
How to set focus on a dynamic control 18 46
It was really hard time for me to get the understanding of Delegates in C#. I went through many websites and articles but I found them very clumsy. After going through those sites, I noted down the points in a easy way so here I am sharing that unde…
The article shows the basic steps of integrating an HTML theme template into an ASP.NET MVC project
An introduction to basic programming syntax in Java by creating a simple program. Viewers can follow the tutorial as they create their first class in Java. Definitions and explanations about each element are given to help prepare viewers for future …

740 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