Document my Javascript code for other developers
- or -
Post a project like this£40/hr(approx. $50/hr)
- Posted:
- Proposals: 5
- Remote
- #22182
- Expired
Description
Experience Level: Expert
I need someone to document some Javascript code which I have written.
Having programming skills would be an advantage because nothing is documented at the moment (as per usual!) so I need someone to read the code and produce documentation from it.
I do not need a programmer, just someone who has a basic knowledge of how Javascript works and what technical documentation is like. I can explain what to look for in the code and then give you an overview of each function and how everything works together.
There are approx 5000 lines of code, 17 files, 50 objects, each with about 10 methods. It is an MVC framework for client side applications.
There is model code which uses an XML API to the server, view code which renders XML templates. The template format must be documented, it has about 15 tags. Then there is a small amount of controller code with only one function which maps the URL to the code which loads the data and template view.
It needs to be documented for other programmers to use, it must include a general overview of the components as well as an API documentation.
If possible, please include a rough estimate of the time it would take to complete.
Having programming skills would be an advantage because nothing is documented at the moment (as per usual!) so I need someone to read the code and produce documentation from it.
I do not need a programmer, just someone who has a basic knowledge of how Javascript works and what technical documentation is like. I can explain what to look for in the code and then give you an overview of each function and how everything works together.
There are approx 5000 lines of code, 17 files, 50 objects, each with about 10 methods. It is an MVC framework for client side applications.
There is model code which uses an XML API to the server, view code which renders XML templates. The template format must be documented, it has about 15 tags. Then there is a small amount of controller code with only one function which maps the URL to the code which loads the data and template view.
It needs to be documented for other programmers to use, it must include a general overview of the components as well as an API documentation.
If possible, please include a rough estimate of the time it would take to complete.
Mike Y.
0% (0)Projects Completed
7
Freelancers worked with
7
Projects awarded
62%
Last project
7 May 2014
United Kingdom
New Proposal
Login to your account and send a proposal now to get this project.
Log inClarification Board Ask a Question
-
There are no clarification messages.
We collect cookies to enable the proper functioning and security of our website, and to enhance your experience. By clicking on 'Accept All Cookies', you consent to the use of these cookies. You can change your 'Cookies Settings' at any time. For more information, please read ourCookie Policy
Cookie Settings
Accept All Cookies