An existing codebase of 10,000 lines needs reviewing, documenting and approximately 50 outstanding issues with it need assessing and a proportion of them, expected to be approximately half of them, resolving.
To make long term use of the modules easier to maintain and more robust in use by developers write two additional documents to serve as introductions to using the modules and to resolve the most beneficial and resolvable issues with it.
The first two modules of just over 7000 lines total have few issues but a templated technical description needs to be completed for each module (Total two) in addition to adding phpdoc format comments (template and instructions available).
The aim is to understand these code modules. Write documents and comments which help others understand them and then to fix a number of issues with these modules. The hope is then that you will go on to do other further work with us.
Successful execution of the project would create two documents in understandable English which speed up the process of understanding the code base and phpdoc comments which can be processed by phpdoc without errors and are complete in describing every function and all arguments.
An example of failure would include writing documents with are verbose, inaccurate or unreadable. Introducing defects or removing required functionality. Distributing the code base to others would be a another clear failure.
The effort on writing the two documents and initial formatting of phpdoc comments can be capped at 8 days. The effort on resolving open issues can be capped at 12 days with some additional comments being added during investigation of the open issues.
A UNIX shell account can be provided to allow editing of the code and testing with phpdoc. The document may be edited with LibreOffice a free open source word processing package.
All rights to the resulting work and related works in all forms will be assigned to us including the right to transfer rights. Your work must be your own and not subject to existing licenses even public or open source licenses. The work may not incorporate copyrighted materials or copy the code or design of existing software.
I'm adding some pdf files which list the files and functions in these code modules.