Rule #19
When asking for content changes do you write change X to Y?
  v19.0 Posted at 15/12/2010 4:47 PM by system
When asking for changes to be made to any file like a web page, Word document, PowerPoint slide or code, always include the original version of the content ("X") together with the changes you require ("Y"). This means you have at hand a history of the page or file as it currently stands allowing forĀ convenient futureĀ reference and also makes it very clear to the person doing the changes exactly what the new file is meant to look like.

Make the changes even easier to see and understand by highlighting in yellow sections you want added/updated and highlighting in red the sections you want deleted.

    Hi Eric,

    For the code auditor web page, please make the green ticks read:

    1. Scan all your projects for coding errors
    2. Enforce Industry best practices
    3. Friendly licensing model
Figure: Bad example - original version of content has not been included in the email

    Hi Eric,

    On the code auditor web page, please change http://www.ssw.com.au/ssw/codeauditor from:

    1. Keep your code consistent across all projects
    2. Add your own Rules Friendly licensing model - pay nothing for full version!

    to

    1. Scan all your projects for coding terrors
    2. Enforce Industry best practices
    3. Friendly licensing model bloggers even pay nothing for the full version!
Figure: Good Example - it has 'From' and 'To' with changes highlighted... so it is clear what needs to be changed
 

Loading
Do you like this rule?
Loading
Do you follow this rule?
Loading

......