Subblocks of program documentation from abstract
I have an abstract that includes the following (feel free to change the formatting:
1. purpose
2. simulation models used
3. libraries, SDKs, and APIs used
4. major components of application in terms of the
windowing blocks, and types of user controls and settings offered in
the application for simulation operation
5. methods of controlling the input coordinates for the simulation to execute
and generate an output
However, now I don't know which subblocks I should work next from a documentation point of view. As someone who doesn't know what my application is doing, do you think it would be more helpful to describe in more detail? Thanks in advance for your suggestions.
source to share
You have at least two documents. Software users care about 1, 2 and 5. Developers are interested in 3. Not sure if implementation is 4 or UI.
I would highly recommend preparing a User Guide first. What can I do with this software, how can I manage it? You may even find that you need to share it by sharing the detailed link from the manual.
Internal stuff may come later.
source to share
For an ordinary user, it will be specific in purpose and settings in the application.
The most important thing for a developer is to use libraries, SDKs and APIs.
Also take a look at this SO question
How do you feel about documentation (external, not code-behind) documentation?
source to share