How to document software algorithms? [closed]

Question

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

Answer 1

Maybe you should then use pseudocode.

Answer 2

Create two documents.

• First: The business process model (BPM) that shows the sequence of steps required to be done. This should be annotated with the details for each step.

• Second: Create a spreadsheet with each input data item defined so that business can see that you understand the type of field for entry of each data point and the rules for each data point. If the calculation uses a table for the step, then that is where you define the input lookup value from the table. So for each step you know where the data is coming from and then going to. Your spreadsheet can include the link to the BPM so they can walk through each data point in the BPM and see where it is coming from/going to.