Web Application Technical Document

Question

I need some guidance and preferably some examples of a web application technical documentation. What specifically do I need to include in the Technical Document?

I have created a web application. Do I document all the pages, classes, dlls, etc?

I hope someone can give some good examples of technical documents they have done for their web application.

If I may care to add, I think the documentation would be used for reference in future support / enhancement. The software which is needing technical documentation is a legacy application conversion (old winforms to web).

Sample technical documents preferable of a web application is highly appreciated.

Thanks.

Answer 1

What is the purpose of the document? Typically an architectural or technical requirement document would have been produced before the code was written. Now that you've already written the code do you need to document it?

If you want to create a document to be read by future developers then a brief overview of the system using UML and API output from the source would probably be enough.

The complexity of your document should match the complexity of your system - there's no point in writing page after page for a simple site. If you are retro-fitting the document then think about what you needed to know when you were writing the system - where were your big problems and which decisions were tough to make? Document those.

Answer 2

http://stackoverflow.com/questions/533126/documents-for-a-project

Answer 3

Hi there,

Even though I have not yet created my very own web application, I can suggest you one along with documentation that you might find very useful. This is an application that I use for my website. It's called WordPress and you can visit my site to find a link to the documentation or you can just run a search using an Internet search engine to get to the documentation. Note: The documentation is extensive, take your time reading and understanding before you start to implement and adapt it to your needs.

Cheers, Eddie Gear