Technical spec

Miscellaneous Forums/General Discussion/Technical spec

The forum is locked. These are the original blitzbasic.com forums, kept so they can still be read. No new topics, replies or edits can be made here. To join in, head over to the Blitz3D+ forums.

6
 #1
From my experiance you would be writing the Functional Spec and the programmer would write the Tech spec.

A functional document is a detailed description of what the system should do and the Tech is how it does this.

There are many ways to write these types of documents but the most important aspect of them is that they are clear and easy to understand. Each company I've worked at has different methodologies of writing Tech and Func specs that suite their particular I.T environment.

Start off with a brief description of what you want the program to do. Then you break down the functionality within the program into smaller parts or objects and describe each one.

For example, if you wanted to make a clone of space invaders and would describe such things as:

Space ship:
move left and right using the Z and X keys.
Ship always points in Y diretion up the screen
Space fires a missle.
Missle always goes up the screen in Y direction

Alien:
Move randomly about on screen
Travel down from top of screen

And so on... You need to obviously put alot more detail in it though.

You could also try out a couple of the UML methods such as Use Cases and Activity Diagrams to help the programmer understand what you want. They also help you better understand how your program will work and what holes may appear later on.

Hope this helps in some way