USer Documentation.

[KingJ]

Hi,
I am going to produce some documentation for my application, that im in the process of building.
What sort of things will i need to include in order to produce a good quality document outlining my project.
Thanks

[VOT Productions]

Comments in code, use

'This is a comment created by the ' character

Use HelpProvider for CHM format help. You MUST put the CHM file in debug/release folder.

I use this for the help button.

Help.ShowHelp(Me, Application.StartupPath & "\Help.chm", HelpNavigator.TableOfContents)
'Shows the help file at the table of contents.

F1 works automatic. Good software to make CHM, HTML, PDF and DOC documentation files is http://www.helpndoc.com/

[Hack]

That will depend largely upon your target audience.

Is this a commerical project or a corporate project? Generally speaking it is easier (I think anyway) to write documentation for a corporate project because you are familiar with the folks that will be reading it.

[KingJ]

Bearing in mind this for for College, and I have to write a 90 Page document about the project! I'm a little stuck about what to write.

[VOT Productions]

The best idea is to tell us what is the application about.

[KingJ]

"Objectives.

This section will outline the objectives that I hope to achieve in the building of this Database Management system. I know that some of them I will be unable to complete, but I am fairly confident that using the following plan I will be able to create an application that does the job, and does the job well.

 Provide a simple and effective design layout that is easy to use.
 Have a means of saving the Customer’s personal details: (including)?
 Displaying a complete and up to data table of data, giving the user the ability to search through the customers / cars. Once selected this data could then be manipulated, to the desire of the user.
 Calculate the final figure of the customer’s chosen car(s). Displaying to them the monthly payment figure based on the information supplied to the company.

The overall main goal of the design is to make the system paperless. Meanining that Customers Quotations can be easily made and saved, ready for editing at a later stage. "