Expected duration: less than 1 week we had a developer build an Html / JS app some years ago as a pilot and now we need the JS scripts(2/3) and their functions fully documented and a top-level overview written to engage others to optimize/improve this small codebase. Essentially the app transform JSON data into HTML/JS output, allowing for a very basic JS/HTML templating system, where user can choose templated HTML/JS components to be inserted into JSON data and then it is outputted to both HTML/JS pages (local website) and JSON file
The top-level overview target audience is for a project manager/ account manager with some technical knowledge but the full functional review is for coders who will look to optimize and remove duplication in order to inc into another App
You will need to go through each function a write description of its I/O param and its action (how it performs on data and user input) once this is achieved, then write a comprehensive overview of how the App works with reference to those functions (maybe a flow diag of data and action), your choice.
I will be the editor of your work and can basic code in Python and PHP so able to discuss in detail your findings and also know what PM and Bus Dev are expecting.
Since no code design/amends is required and only a read-through top to bottom of the code and documenting as you go and then a comprehensive top-level overview is required it should be straightforward for intermediate level and act as a manual for them to interact with the coder and explain to nontechnicals how the App performs
The expected output is 2 fold,
A) A word doc with a top-level overview of how the app performs describing the action of the main functions and outlining data flow, to inc variables and transition from json to the end result. Include a summary of each of the functions brief description of their actions and params (if JSDOC is used no need for a detailed summary).
B) Inline code commenting of the functions either using a system ( like JSDoc or other) or just comment strings, description of action, and params
You need to have good JS knowledge, good technical writing skills, and can demonstrate previous technical documenting examples, so an HTML/JS tester would be ideal.
