Standard Documentation for system written in Vb.NET, C#.NET, and SQL Server 2005
$100-500 USD
Cancelled
Posted over 16 years ago
$100-500 USD
Paid on delivery
I need a coder to write comprehensive documentation on an existing system written mostly in VB.NET with some C# components and a SQL Server 2005 backend with two moderately sized SSIS packages.
The code is comprised of approximately 300 files (includes both front-end and code-behind) with an average of 250 lines of code per file.
The database is comprised of 70 tables (many are duplicated temp tables), 95 stored procedures, and 10-15 data functions.
**Inline Documentation Deilverable Requirements
**----------------------------------------------------
This part of the project will require the coder to read existing inline comments, trace processes, trace data-flow, organize code blocks into logical/visually separate separators, correct inaccurate existing inline documentation. (commenting for general code, functions, routines, controls, etc.)
**External Documentation Deliverable Requirements**
----------------------------------------------------
Detailed data schema with flow charts for the SQL Server database including stored procedures and 2 SSIS packages.
All Object structures and I/O detailed using standard format similar to what you see on MSDN (a "Class Library" with definitions for objects, methods, properties, etc. as well as a syntax example).
Detailed process flow diagrams for all significant code/programatic processes from input to output.
**Other Important Coder Considerations**
-------------------------------------------
I want to be able to use the coder(s) who write this documentation for planned upgrades to the system. This means it is very important
that the coder(s) involved are as good at coding as they are with writting documentation. If this project is done well, I have a lot more significant projects that need to be done involving the cleaning-up and upgrading of this system.
## Deliverables
1) Complete and fully-functional working program(s) in executable form as well as complete source code of all work done.
2) Deliverables must be in ready-to-run condition, as follows (depending on the nature of the deliverables):
a) For web sites or other server-side deliverables intended to only ever exist in one place in the Buyer's environment--Deliverables must be installed by the Seller in ready-to-run condition in the Buyer's environment.
b) For all others including desktop software or software the buyer intends to distribute: A software installation package that will install the software in ready-to-run condition on the platform(s) specified in this bid request.
3) All deliverables will be considered "work made for hire" under U.S. Copyright law. Buyer will receive exclusive and complete copyrights to all work purchased. (No GPL, GNU, 3rd party components, etc. unless all copyright ramifications are explained AND AGREED TO by the buyer on the site per the coder's Seller Legal Agreement).
## Platform
Microsoft Server 2003, .NET 2.0, SQL Server 2005, and SSIS.
**Excellent written english skills are critical to this project.**