Comments at the start of the program that will tell the programmer what was used to make this program work
First, i know i could make a XML file with tags, to describe each section of a program,
requirements, diagram etc. Or a visio or word document.
It would be better, but we have a time constraint and a tool constraint.
Tool constraint
You could be in notepad programming some PHP or windows script, or vb.net or Delphi, or ladder
Finding a common way to describe your program, it's requirements and it's structure is of course what is called documentation. You would have to run Visio (for a diagram), word editor, for a description, another word editor, for troubleshooting the interaction of your program with other softwares (windows, web browser etc.)
Time constraint
Also, your boss want the program "soon" so you do not have time to update your documentation and your program at the same time
In conclusion, we will use comments in the program to do almost everything (a user guide can be done later in a document)
There will be a few levels to the standard
The first one to include things in the header
1.1 The name of the program
1.2 Revison of the program
1.3. The author of the program
1.4. How to communicate with the autor (I suggest you make a blog for each program)
1.5. The function of the program
1.6. The software used to make the code (visual studio, notepad aka, text editor)1.7. The platform used to interact with the user (windows, a panel view, a Mac)
1.8. The requirements (inplements, include, imports, libraries that will be used by the program. Usually come from the platform)
'=== outlook addin model 01
'=== 2015-07-05 start program
'=== by Serge Fournier, 2015-07-05
'=== sergefournier @ hotmail.com (remove space before sending)
'=== this program is a outlook addin model to make more outlook addins
'=== program used: visual studio 2013
'=== Platform: windows 7 sp1
'=== require .net 4.5, outlook 2013
