Commit 49022f2c authored by thomas.forbriger's avatar thomas.forbriger

[WP] (issue12): update TODO list

Remove all items describing accomplished tasks.
Outline staps to take.
parent 96d724b8
......@@ -3,40 +3,15 @@ this is <issue12_libstfinv_and_soutifu_improve_user_documentation.txt>
libstfinv and soutifu: improve user documentation
-------------------------------------------------
The library is missing appropriate and comprehensive user documentation.
replace "engine" by "procedure" in the end-user documentation
steps to take:
* implement mechanism for output of end-user documentation
* transfer existing texts to usage text files
* revise existing usage information
Status report
* Existing doxygen documentation is reorganized
* Location and purpose of different types of documentation are defined (see
doxygen_implementers.txt line 139)
* Template text files for end-user documentation are prepared
* Mechanism for output of end-user documentation is defined (see
doxygen_implementers.txt line 202)
Next steps
* implement mechanism for output of end-user documentation
* transfer existing texts to usage text files
* revise existing usage information
replace "engine" by "procedure" in the end-user documentation
Changes applied to master with commit 4e3c31ce:
* end-user usage documentation is provided through ASCII text files
* end-user usage descriptions are revised and partially rewritten
* libstfinv provides structured usage information either as a summary for
all available procedures or as a detailed description for a selected
procedure
* soutifu outputs all end-user documentation on request
User documentation still is not fully satisfactory.
Steps to take:
- replace "engine" consistently by "procedure" in the end-user documentation
and possibly in other places too
- provide a guide to documentation including mutual cross-references for
libstfinv and soutifu
- provide a useful preliminary version of the LaTeX documentation
- provide a step-by-step example
- provide a toy-example
----- END OF issue12_libstfinv_and_soutifu_improve_user_documentation.txt -----
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment