Seeing the wood for the trees.
I write training notes and examples, showing people how things work in Perl / PHP / other languages.
Newcomers need short examples to show them the real "nuts and bolts" of how a job is done. Live applications need additional code for error checking, for handling security issues, and to make applications robust and user friendly. As a rule of thumb, this extra code accounts for over 50% of the code volume.
Solution(s) to this dilemma.
a) Examples in our training folders are kept short so that newcomers CAN see the wood without it being lost in the trees
b) Training notes include warnings that the code shows the mechanisms, but needs to be extended to take into account usability / error / security issues as applicable to the individual application
c) All examples include a disclaimer when displayed on our web site which emphasises that they are training examples.
d) During our courses, we include coverage of programming standards / security / maintainability issues, with examples. Coverage of these important topics is more thorough than you would expect, and we include the subject on private courses even if it's not explicitly requested by the customer.
(written 2004-08-06, updated 2012-11-04)
Associated topics are indexed under
G504 - Well House Consultants - Writing Notes [4031] Showing what programming errors look like - web site pitfall - (2013-03-06)
[4009] Clear, concise examples - Ruby classes and objects. - (2013-02-17)
[3152] Jargon busting - (2011-01-30)
[2828] Sharing our programs - easy. Sharing our data - harder. - (2010-06-26)
[2812] What is Perl? - (2010-06-15)
[2481] Sample code with errors in it on our web site - (2009-10-29)
[2414] Hello World - a good traditional start to a Java course - (2009-09-22)
[2192] Copy writing - allowing for the cut - (2009-05-21)
[2010] How long should a training module be? - (2009-01-27)
[1950] Copyright of Training Notes and Web Site - (2008-12-18)
[982] Notes from the white board - (2006-12-14)
[979] Empty seats, Nodding Donkeys and buses - (2006-12-11)
[797] Writing up new C / C++ notes. - (2006-07-09)
[407] Theft of training material - (2005-08-09)
[398] Training course material - why we write our own - (2005-07-30)
[394] A year on - should we offer certified PHP courses - (2005-07-28)
[9] Study room - the Oxford train - (2004-08-10)
[7] Writing on a Sunday - (2004-08-08)
Some other Articles
How much does fuel cost for an airline flight?Blog v ForumDriving in the UK for new arrivals from the USASeeing the wood for the trees.Looking for a donkeyDiary entry - 5th August 2004First Jottings