?
Solved

Application Documentation

Posted on 2012-08-20
1
Medium Priority
?
500 Views
Last Modified: 2013-11-29
I am looking for a document that is a good example on documenting a custom application build, from the platform to the data routing, protocols, and the database, etc.  Does anyone know or have a good example for this?
0
Comment
Question by:Jack_son_
1 Comment
 
LVL 111

Accepted Solution

by:
Ray Paseur earned 2000 total points
ID: 38315683
There is no "one thing" here -- but some of these links may give you good starter ideas.  Make sure you incorporate the value of this work in your estimates and proposals, or incorporate it as a change order.  I often find that the time spent on this activity exceeds the time spent creating code and data bases!

http://en.wikipedia.org/wiki/Affinity_diagram
http://en.wikipedia.org/wiki/Comment_%28computer_programming%29
http://en.wikipedia.org/wiki/PHPDoc
http://en.wikipedia.org/wiki/Website_wireframe
http://en.wikipedia.org/wiki/Entity%E2%80%93relationship_model
http://en.wikipedia.org/wiki/API_documentation
0

Featured Post

Concerto Cloud for Software Providers & ISVs

Can Concerto Cloud Services help you focus on evolving your application offerings, while delivering the best cloud experience to your customers? From DevOps to revenue models and customer support, the answer is yes!

Learn how Concerto can help you.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

Many old projects have bad code, but the budget doesn't exist to rewrite the codebase. You can update this code to be safer by introducing contemporary input validation, sanitation, and safer database queries.
The title says it all. Writing any type of PHP Application or API code that provides high throughput, while under a heavy load, seems to be an arcane art form (Black Magic). This article aims to provide some general guidelines for producing this typ…
Explain concepts important to validation of email addresses with regular expressions. Applies to most languages/tools that uses regular expressions. Consider email address RFCs: Look at HTML5 form input element (with type=email) regex pattern: T…
Viewers will learn how to properly install and use Secure Shell (SSH) to work on projects or homework remotely. Download Secure Shell: Follow basic installation instructions: Open Secure Shell and use "Quick Connect" to enter credentials includi…
Suggested Courses
Course of the Month16 days, 8 hours left to enroll

862 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question