Internal development documentation for software product

Question

1.00/5 (1 vote)

See more:

Hello developers,

I hope you are doing great.
I have created a Software Product for my organization and now i want to create a 'Internal Development Document'. The documentation should explain each and everything including the workflow of the system as well as the coding.
The aim is to develop a document that will help both non-technical and technical users so that it can help them in understanding the nitty gritties of the product.
The document should also help the technical support team or any new developer in understanding the logic and code behind the product.
The product is developed using ASP.NET and MS-SQL.
I would be greatful if you can help me in this regard or give some examples of already created documents as i have not made any document before and i want to create a best one.

Thanks a ton.

What I have tried:

Searching the web regarding the documentation, but i am unable to find any sample document.

Posted 14-Feb-17 18:31pm

Faran Saleem

Updated 14-Feb-17 18:47pm

Add a Solution

Comments

[no name] 15-Feb-17 9:30am

"i am unable to find any sample document", a sample document for what? There must be thousands and thousands of sample documents out there on the web so I can't believe you tried very hard.

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Cynnie Jia · Answer 1 · 2017-02-14T18:47:00

Solution 1

you can use GhostDoc to do something,when you start writing code.
It can help you generate program documentation.

Posted 14-Feb-17 18:47pm

Cynnie Jia

Comments

Faran Saleem 15-Feb-17 1:01am

I have checked it but their website says that it is not for organization.
I want to have a proper documentation, i can write it myself but it would be much easier for me if i can get a sample from somewhere which can help me in understanding of how a technical document should look like.