I am the owner of a small web-based medical database service.
I am looking for professional technical writer who can “fully” document our Java Application which will include all the jsp pages, servlets, java classes and java website. Roughly 500 pages but many are just a few lines of code (between 8 lines to 500 lines of code).
In addition, we have a MS SQL database with procedures and other calculated fields. Roughly 50 tables but only a few are primary, the rest are supporting tables.
I am going through the copyright process as well as working with a software escrow agency to help protect my clients in the event that if something should happen to my programmers or my company, I would have the proper documentation in place to assure my clients that our software has clearly written manuals/documentation that another programmer could follow if necessary.
Basically I am looking for a Java Software Engineer who really enjoys creating software documentation and user manuals with the graphic skills of a manual writer and the clarity and organization of an Engineer AND have good English writing ability.
Once this project is completed successfully, there will be some smaller continued monthly work to maintain these documents as we continue to add/change our software. Ideally we would develop a longer working relationship as my company has many new potential projects.
To be seriously considered, you must submit to me some examples of prior work and explain the method by which you would document this (what program would you use to create the documentation/manuals).
If you have never done something like this before professionally, please don't apply.