How to prepare technical document of a web application.

Question

User1052662409 posted

Hello Everyone !

I have developed a web application using asp.net technology along with C# and MSSQL.

This time my requirement is, I need to prepare a technical document.

This document should be module wise. Document should contain C# code, SQL code with the definition of module.

I have never did this before and looking for on internet but didn't find any or may be I missed as I don't have much knowledge about documentation.

Could you please share any link, reference or any knowledge which can help me out.

Thanks

Answer 1

User475983607 posted

See Visual Studio XML code documents.

https://docs.microsoft.com/en-us/dotnet/csharp/codedoc

https://docs.microsoft.com/en-us/visualstudio/ide/reference/generate-xml-documentation-comments?view=vs-2019

Answer 2

User1052662409 posted

https://docs.microsoft.com/en-us/dotnet/csharp/codedoc

https://docs.microsoft.com/en-us/visualstudio/ide/reference/generate-xml-documentation-comments?view=vs-2019

Sir, I never saw any technical document before. And I am wondering that technical document have only overview or it includes all code too?

Thanks 

Answer 3

User475983607 posted

Sir, I never saw any technical document before. And I am wondering that technical document have only overview or it includes all code too?

You have to write the documentation.   In Visual studio you can add code comments to method, properties, classes by entering three single quotes in C# or three slashes in VB. You can configure Visual Studio to save the comments as an XML doc.  Then you can transform the XML to whatever format you like.  There are also tool to transform the doc.  Simply Google.

Please read the docs in my first post.

Answer 4

User753101303 posted

Hi,

What is the purpose ? If you copy C# or SQL code it will be outdated sooner or later. You have tools such as "database project" which allows to store the db state you want (object definitions) and compare that to a target database to see differences (and possibly fix them).

In some editions you have tools such as https://docs.microsoft.com/en-us/visualstudio/modeling/visualize-code?view=vs-2019 but it is available only in higher edition (I believe Enterprise only, you can READ graphics using lower editions). You may find 3rd party tools maybe suhc as https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml etc...

IMO the first step is to make sure about which objectives you have to avoid creating a documentation that could be soon obsolete and not used any more. It would be best if it could be done and updated quite quickly rather than handcrafted and requiring much work for maintaining it up to date...