Skip to main content
Tweeted twitter.com/StackSoftEng/status/1075224475711483904
spelling and stuff
Source Link
ChrisF
  • 38.9k
  • 11
  • 126
  • 168

Seeking adviseadvice on system documentation

I have a rating engine (it is basically an algorithm) which when iI started had no formal documentation. We have created a functional specspecification/decomposition which is our business level document but now iI need something more technical (a technical specification).

What iI am struggling to understand is what that document looks like, what format it should be in and to what level of detail we should go into.

We are in the process of commenting all of the code. We also have a rough document called a Blueprint which reflects the flow of the model and is written in pseudo code. Is the combinatincombination of this blueprint and the model comments sufficient as a Technical Specification?

Any opinion/advice would be appreciated.

Seeking advise on system documentation

I have a rating engine (it is basically an algorithm) which when i started had no formal documentation. We have created a functional spec/decomposition which is our business level document but now i need something more technical (a technical specification).

What i am struggling to understand is what that document looks like, what format it should be in and to what level of detail we should go into.

We are in the process of commenting all of the code. We also have a rough document called a Blueprint which reflects the flow of the model and is written in pseudo code. Is the combinatin of this blueprint and the model comments sufficient as a Technical Specification?

Any opinion/advice would be appreciated.

Seeking advice on system documentation

I have a rating engine (it is basically an algorithm) which when I started had no formal documentation. We have created a functional specification/decomposition which is our business level document but now I need something more technical (a technical specification).

What I am struggling to understand is what that document looks like, what format it should be in and to what level of detail we should go into.

We are in the process of commenting all of the code. We also have a rough document called a Blueprint which reflects the flow of the model and is written in pseudo code. Is the combination of this blueprint and the model comments sufficient as a Technical Specification?

Source Link

Seeking advise on system documentation

I have a rating engine (it is basically an algorithm) which when i started had no formal documentation. We have created a functional spec/decomposition which is our business level document but now i need something more technical (a technical specification).

What i am struggling to understand is what that document looks like, what format it should be in and to what level of detail we should go into.

We are in the process of commenting all of the code. We also have a rough document called a Blueprint which reflects the flow of the model and is written in pseudo code. Is the combinatin of this blueprint and the model comments sufficient as a Technical Specification?

Any opinion/advice would be appreciated.