Having launched into attempting to document the code a few interesting problems are coming out of the woodwork - one of them relates to how to document the data in a manner that can be understood in simple terms!
The plan is to document the following;
1 Process flow document in the form of a flowchart - easy one this one and very good for viewing the code without the clutter.
2 Documentation of the underlying physics and numerical modelling techniques - again relatively easy and can be linked to the flowchart in a logical manner.
3 Data documentation - absolute nightmare - the data structure is pretty difficult to follow without the added complication of spaghetti-like contortions of the variables throughout the code.
Need to come up with simple way of 'viewing' these data flows.
All ideas welcome!
No comments:
Post a Comment