.NET Application UI/Screen Documention Help

I

Ian Ceicys

I’ve been tasked with doing documentation on the project I’ve recently
joined. Here’s what I’m looking for in terms of documentation. I want to
generate a diagram from a huge .net 1.1 Winforms application that relates
every form with the corresponding button/command that invokes that form. In
other words I want to output a diagram that traces the flow (workflow is the
right term?) of what happens when every single button/command is executed on
every single form.

Think of it this way:

Form1 (contains) Command1 (invokes) Form2 (contains) Command2 (invokes) Form 3

I’ve been using Visio for Enterprise architects to do this process manually
creating screen shots of each form and of each individual buttons (part of
the requirement from the project specification) but having discovered that
the application has more that 285 screens and approximately 3 buttons per
screen the manual process is to time intensive for the sheer size of the
application.

In addition the end goal is to have the diagram driver by an Access database
(hence my desired use of Visio for its “exporting to database†function) that
can be used to add additionally entry of form images and buttons that will
automatically be drawn and connected on the diagram.

Here’s a sample scenario:
Step 1) User launches application and ApplicationMenuLogin screen appears.
Step 2) User enters credentials and presses the “login†button
Step 3) Login is verified and is successful and “Application Point of Salesâ€
screen appears
Step 4) User presses “Update Order buttonâ€
Step 5) Order Edit form appears.


Here is a sample of a one of the screens in Visio and what I’m looking for
from a automated tool.
http://www.techcacophony.net/images/ApplicationUIDocumenation.JPG

And here is the information I need to capture about every screen:

Screen Number = 30
Screen TitlePath = Screen30.BrowseVehicleMakesModels
Screen Shot Filepath = \Screen30.BrowseVehicleMakesModels.JPG
Windows Caption = Browse Vehicle Makes
Description = Vehicle Makes Model Screen
SourceSystemAreaID = Vehicle

Here is the information I have to capture from every button/menu item/
toolstrip item
Example the “Add†Button of the form image above



CommandID = 45
Screen ID = TalonScreen30.BrowseVehicleMakesModels.Add
CommandTypeID = 1
Command Label = Add
Description = Button on TalonScreen30.BrowseVehicleMakes/Models for Add
Command Screen Shot Filepath =
\TalonScreen30.BrowseVehicleMakesModels.Add.JPG
Section Title = Vehicle
Visio Page # = 25
Visio Directed Page # = 25
Directed Screen title = TalonScreen31.UpdateaModelMfg
Directed Screen ID# = 31

Is the any tool/add-in for Visio that automatically generates a UI flow
diagram like this?


And is there another tool that will automatically generate Jpg images of
individual screens?


Thanks for the help.
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Top