documenting complex software

1 view
Skip to first unread message

Matt Kime

unread,
Nov 20, 2009, 2:06:25 PM11/20/09
to nycresistormi...@googlegroups.com
i was curious if anyone out there is familiar with tools for visually
documenting complex software. i'm working on a very complex web
application and i'd like to produce a site map for it. however, a site
map doesn't capture the amount of detail that i need, perhaps exploded
view is a better term.

most 2d software packages would fall apart due to the number of screen
shots. page layout apps could handle it but i'd end up creating one
giant page. i've used OmniGraffle for simpler sites and have been
extremely happy with it but it doesn't work well with screen shots.
I've even started considering autocad since i know that it could cope
with the complexity.

or perhaps i need a site map & detail pages for each page.

has anyone else tackled this?

thanks,
matt

Sam Epstein

unread,
Nov 20, 2009, 3:05:13 PM11/20/09
to nycresistormi...@googlegroups.com
I can't say that I've dealt withthis problem specifically, but using
AutoCAD for this kind of thing is a pain. If you do end up using
AutoCAD look into blocks(I believe that's what the feature is called).

-Sam
> --
>
> You received this message because you are subscribed to the Google
> Groups "NYCResistor:Microcontrollers" group.
> To post to this group, send email to nycresistormi...@googlegroups.com
> .
> To unsubscribe from this group, send email to nycresistormicrocon...@googlegroups.com
> .
> For more options, visit this group at http://groups.google.com/group/nycresistormicrocontrollers?hl=
> .
>
>

Matthew Sparks

unread,
Nov 20, 2009, 4:14:47 PM11/20/09
to nycresistormi...@googlegroups.com
Try visio.

Alpay Kasal

unread,
Nov 20, 2009, 4:44:07 PM11/20/09
to nycresistormi...@googlegroups.com
I have used Visio for this too but have been watching this thread in
case there is something better. Visio is dumb easy and you can download
libraries of graphics for your industry... When i have needed to create
flow charts for use in marketing materials I have to fallback to
Photoshop for higher quality however.... but that doesn't sound like
your deal.

if you take a look at "mind mapping" software, you get the added
benefit of managing connections and viewing relationships rather than
just visually mapping static stuff. i like personalbrain

Alpay Kasal
Artist/Engineer
blog: http://blog.LitStudios.com
twitter: @alpaykasal

Matt Kime

unread,
Nov 20, 2009, 5:21:37 PM11/20/09
to nycresistormi...@googlegroups.com
how is visio at including graphics? Does it link to them (like a
layout app) or incorporate them into the file?

Alpay Kasal

unread,
Nov 20, 2009, 5:26:39 PM11/20/09
to nycresistormi...@googlegroups.com
I don't remember how it handles external graphics but the included
lbraries (of say typical flowchart shapes, or industry standard
bluprint synbols or electronics symbols) are all a part of the saved
file, not referenced to a file on your harddrive.

I found a video tutorial so you can see what it looks like out-the-box:
http://www.ischool.utexas.edu/technology/tutorials/office/visio/flash/visio.html


Alpay Kasal
Artist/Engineer
blog: http://blog.LitStudios.com
twitter: @alpaykasal



Dave Pentecost

unread,
Nov 20, 2009, 11:11:02 PM11/20/09
to nycresistormi...@googlegroups.com
For OS X - Omnigraffle

http://www.omnigroup.com/applications/OmniGraffle/
Center for Community
Lower Eastside Girls Club
http://www.girlsclub.org/building

Community Base
http://c4c.posterous.com

Cell 646 704 2021

Kevin Mark

unread,
Nov 21, 2009, 3:04:05 AM11/21/09
to nycresistormi...@googlegroups.com
On Fri, Nov 20, 2009 at 11:11:02PM -0500, Dave Pentecost wrote:
> For OS X - Omnigraffle
>
> http://www.omnigroup.com/applications/OmniGraffle/
>
>

Interesting. says it is related/uses graphviz -- something in the free software
world that can understand dotty files. So that there would be a way to
programmatically make a diagram if you could understand the language.

--
| .''`. == Debian GNU/Linux == | http://kevix.myopenid.com |
| : :' : The Universal OS | mysite.verizon.net/kevin.mark/ |
| `. `' http://www.debian.org/ | http://counter.li.org [#238656]|
|___`-____Unless I ask to be CCd, assume I am subscribed _________|

pratt2

unread,
Nov 21, 2009, 9:46:16 AM11/21/09
to nycresistormi...@googlegroups.com
when I used visio i used to take pics of the front of each server and
then use them at the objects. lines could be connected just like any
other object

I went and got the stock apc rack 42u diagram off the web and then
filled it with the real server faces. it looked perfect

I then used omnigraffle and loved that

now its someone else job and he still uses visio and his digital camera
Reply all
Reply to author
Forward
0 new messages