General discussion

Locked

Software Documentation

By jsuarez ·
Does anybody know of an online source for current trends in software documentation.

Thanks...

This conversation is currently closed to new comments.

9 total posts (Page 1 of 1)  
| Thread display: Collapse - | Expand +

All Comments

Collapse -

Software Documentation

by Foss In reply to Software Documentation

what exactly do you mean? Have you tried amazon.com? Have you tried searching on Yahoo, Excite, Dogpile?

Best of Luck

Collapse -

Software Documentation

by jsuarez In reply to Software Documentation

The question was auto-closed by TechRepublic

Collapse -

Software Documentation

by Wayne M. In reply to Software Documentation

Currently, the hot trend in software design documentation is UML. As a jumping off point, try http://www.rational.com This is a company founded by the major developers of UML.

If you decide to use UML, you may just want to use a basic drawing program like Visio, instead of buying a full blown UML design package.

- Wayne

Collapse -

Software Documentation

by jsuarez In reply to Software Documentation

The question was auto-closed by TechRepublic

Collapse -

Software Documentation

by JeffL In reply to Software Documentation

Ok, I'm not sure if you mean here so I'll try to go both directions...

...Documentation as in tracking:

There are a number of software packages out there that were made to track what software you have, where it is, where it's been installed, etc. All of the packages I've looked at gave me too much fluff and not enough of what I wanted. We currently use Excel and good old elboe grease to track licensing and software. There are a number of on-line sites out there but all the ones I've found are for a product.

...Documentation as in creation:
If you meant documentation as in help files, etc., I'm nt sure there's a single authority on the subject. When I have questions about how something should be documented, I normally turn to the following site for help:

http://www.webring.org/ringworld/comp/prog.html

Hope this helps!

Collapse -

Software Documentation

by jsuarez In reply to Software Documentation

The question was auto-closed by TechRepublic

Collapse -

Software Documentation

by Al Macintyre In reply to Software Documentation

There are two kinds of software documentation.

There is the stuff needed by the next programmer who will need to maintain the software that you wrote.

For that, I suggest a STYLE GUIDE for the language that you are writing in ... for example, I use
http://www.as400network.com

Prior to that kind of source, any book by Ed Yourdon would be good because they tend to be independent of language.

Second kind of documentation needed is that aimed at the end user of the software & that ismuch more difficult to organize since different users are at different levels of needing degrees of explanation, so what is needed is to learn how to communicate & to get at good tools for creating documentation that is interlinked like hyper text.
You know like you are on the web & there is a blue line underlined & you click on that link & it takes you to another page.

End user documentation needs to be written using that kind of user-friendly standard, but each page of text needs to effectively communicate

Collapse -

Software Documentation

by jsuarez In reply to Software Documentation

The question was auto-closed by TechRepublic

Collapse -

Software Documentation

by jsuarez In reply to Software Documentation

This question was auto closed due to inactivity

Back to Desktop Forum
9 total posts (Page 1 of 1)  

Hardware Forums