Sign in to follow this  

Looking for tool to help write software design document

This topic is 3319 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

If you intended to correct an error in the post then please contact us.

Recommended Posts

Hey! I'm just about to finish writing my game design document. I've written that in LaTeX. For those of you who don't know what LaTeX is, the result is regular document in a pdf. This is good and simple if I want to send it to someone else for review or whatever. But now comes the time to write a software design document, and I know from experience that those can get much longer. In a software engineering course in school, our requirements document (game design document in the case of a game) was about 35 pages, and the software design document was like 120 pages or something. Also, I think the software design document is, more often than the game design document, used as a reference where you look things up as you are developing the software. With these things in mind, having the software design in a regular text document does not seem very convenient. I think the best solution would be to have the software design document split up into html pages or something, with modules containing links to classes, and classes containing links to functions etc. I thought there must be some tool out there that does this kind of thing. I mean writing the whole html would be tiresome. Do you know of anything close to what I'm looking for? Maybe I'll end up writing my own tool, because I care very much about readability or whatever of the document. By the way, if anyone thinks this thread is more suited to another subforum like Software Engineering or General Programming feel free to move it.

Share this post


Link to post
Share on other sites
I can't really answer about the best tool for software design document, but all of my work for game design documents have been with Word. I have found this invaluable because not only can you add links inside of the documents, but coupled with Visio you can embed your Visio charts directly into the Word document. Being able to embed a Visio flowchart does wonders for communicating the flow of game states and menu flow with programmers (who seem to not particularly enjoy reading text).

Share this post


Link to post
Share on other sites

This topic is 3319 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

If you intended to correct an error in the post then please contact us.

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

Sign in to follow this