Documentation of Web Projects

Posted on 2003-02-25
Medium Priority
Last Modified: 2009-12-16
We have a web project in our company whose documentation is really poor. I recently joined the company and am not able to comprehend the intricacies. My question is that is there a formal, standard way of documenting Web Projects?? the project is COM - based
The layers are:-
ASP - COM - StoredProcedure.
I want to re-document the project in a simple, easily comprehendable way
Please help me on this. Thank you
Question by:RajeshTN
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions

Expert Comment

ID: 8016042
i think there is no way to auto generate documentation for ASP etc., i am afraid. for stored procedures there might be documentation from the vendor if they were not built in-house. documentation in itself would become a project if there is a lot of it to be done! java has javadoc which creates really good documentation using class hierarchys and comments etc. i am assuming that's what you want to do. you can try: http://www.winnershtriangle.com/w/Products.ASPNETDocumentationTool.asp

good luck ;)

Accepted Solution

brandonh6k earned 300 total points
ID: 8018095
Check out Joel On Software (http://www.joelonsoftware.com/navLinks/fog0000000247.html)  There's a great article on writing functional specifications.

Otherwise, Rational has released a White Paper on an extension to UML for documenting Web-based applications if you want to get that involved. (http://www.rational.com/media/uml/resources/documentation/27662_webapps.pdf or http://www.rational.com/uml/resources/documentation/index.jsp for more links).

Hope this helps.


Author Comment

ID: 8032224
thanks that was great help. I appreceate the response of everybody  

Featured Post

Why Off-Site Backups Are The Only Way To Go

You are probably backing up your data—but how and where? Ransomware is on the rise and there are variants that specifically target backups. Read on to discover why off-site is the way to go.

Question has a verified solution.

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

Color can increase conversions, create feelings of warmth or even incite people to get behind a cause. If you want your website to really impact site visitors, then it is vital to consider the impact color has on them.
This article was originally published on Monitis Blog, you can check it here . Today it’s fairly well known that high-performing websites and applications bring in more visitors, higher SEO, and ultimately more sales. By the same token, downtime…
Viewers will get an overview of the benefits and risks of using Bitcoin to accept payments. What Bitcoin is: Legality: Risks: Benefits: Which businesses are best suited?: Other things you should know: How to get started:
Any person in technology especially those working for big companies should at least know about the basics of web accessibility. Believe it or not there are even laws in place that require businesses to provide such means for the disabled and aging p…
Suggested Courses

741 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