Write tech documentation for our Time Entry system
$100-250 USD
Suoritettu
Julkaistu yli 18 vuotta sitten
$100-250 USD
Maksettu toimituksen yhteydessä
You will write technical documentation on how our timesheet system works. This will be “internal?? documentation, describing how the screens, tables, queries, reports, etc. function. This is not "end user" documentation; it is intended to be used by programmers. We will use this documentation (in combination with many other things) to introduce new programmers to our project. Of course you cannot create technical documentation out of thin air; you need some kind of input information. The “input?? data is in the ZIP file with this document. It includes: * Screenshots * SQL file showing the table definitions * Audio recording, which contain descriptions and explanations of the screens, tables, field, etc. * Video recording “screencast??, of the system in use, with an audio explanation. For more details, and the audio and video recordings, download the attached file. In your bid, please point out examples of any similar work you have done in the past.
## Deliverables
The final deliverable result of this project will be a document, in Microsoft Word format. It may also include diagrams, screenshots, charts, etc. as needed to explain the information effectively. It should definitely include an entity diagram (a simple diagram is fine, fancy UML is not necessary). More details are in the download.
* * *This broadcast message was sent to all bidders on Tuesday Oct 25, 2005 6:49:10 PM:
Hello. Several bidders asked about the "[login to view URL]" file. This is a small piece of the source code for this system; there is an audio explanation of this code (about 4 minutes long) that I forgot to include in the ZIP file. It helps explain more about how the system works, it will be very helpful in writing the document. I will send this file, and of course answers to whatever questions come up, to whichever bidder I choose for this project.
## Platform
The output of this is mostly a document, so there is no technical platform per se. However, you will need Windows to view the audio and video recordins, they are "WMV" and "WMA" files. (I did not have generic screencast and audio recording tools handy.)