Software Documentation

Posted on 2008-10-02
Medium Priority
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?
Question by:sepknow
LVL 55

Accepted Solution

Jaime Olivares earned 1000 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.
LVL 11

Assisted Solution

PlatoConsultant earned 1000 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.

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

Featured Post

Free Tool: Site Down Detector

Helpful to verify reports of your own downtime, or to double check a downed website you are trying to access.

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.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

Join & Write a Comment

High user turnover can cause old/redundant user data to consume valuable space. UserResourceCleanup was developed to address this by automatically deleting user folders when the user account is deleted.
Today, unlike web development, the mobile landscape is complex enough for a software engineer and Android is posing more challenging environment thanks to its fragmentation issues on hardware and software fronts.
In this fifth video of the Xpdf series, we discuss and demonstrate the PDFdetach utility, which is able to list and, more importantly, extract attachments that are embedded in PDF files. It does this via a command line interface, making it suitable …
Starting up a Project

627 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