This was an interesting excursus from our usual web design curriculum: we were to design user documentation for the Windows Snipping Tool, which of course is invaluable for taking screen "snips" quickly and efficiently without having to use the "Prnt Scrn" button and then paste the clipboard contents into an image editing program for further cropping/resizing etc. (Click the image to view the PDF)
Figure 10: The Windows Snipping Tool User Manual
We have already seen examples of documentation in our resources section on C# programming. These are good, albeit lengthy examples. There's a saying that goes,
Nothing could be said more aptly about user manuals, documentation and guides, etc. You will need to find suitable material for you to read and then take what is necessary to enhance your own knowledge.
As we have seen, the importance of commenting code cannot be understated. It provides a reference for the programmer to remind himself or herself what he or she was doing at that particular time. It allows others who are working with the same source to understand this and even communicate with one another. In short, commenting code is a way of adding information that is totally user readable to code that is occasionally complicated or obscure. Comments can even help make complicated code easier by reminding the programmer of shortcuts and more efficient methodologies of programming.