views:

66

answers:

6

I'm working on a large project for a university assignment, we're developing an application that is used by a business to compile quotes for their various services.

I need to document the algorithms in a way that the client can sign off on to make sure the way we calculate the prices is correct

So far I've tried using a large flow chart with decisions diamonds like in information systems modelling but it's proving to be overkill for even simple algorithms.

Can anybody please suggest some ways to do this? It needs to be as little like software code as possible, and enough for the client to see how we decide what prices are quoted

A: 

Maybe you should then use pseudocode.

thelost
A: 

You can prepare screen designs to show the users how your system is doing actually.

deih
A: 

Well, the usual way to document algorithms is writing papers. If your clients have studied business, I'm sure they are familiar with reading formulas.

Thomas Ahle
A: 

Would a data flow diagrams help? Put psuedo code or math in the bubbles. I've had some success combining data flow models and entity relationship diagrams, but it's non standard.

Michael Burrows
A: 

What about Nassi-Shneiderman-Diagram, it's a diagram from structural programming. I think its good to show decision flows.

http://en.wikipedia.org/wiki/Nassi%E2%80%93Shneiderman_diagram

martin
A: 

You could create an algorithm test screen to display and comment on the various steps through the calculations.

Mark Redman

related questions