Thread: Software Best Practices Training topics required

  1. #1
    Registered User
    Join Date
    Aug 2010
    Posts
    1

    Software Best Practices Training topics required

    Sorry to post this mundane question here, but I need help!

    I have to do a 1 hour Software Best Practices Training for some
    programmers in my company. Audience are Freshers to couple of years
    experience guys.

    Can you guys please suggest some relevant topics I can cover?

    I could think of the following:

    1) Importance of following coding standards, indentation
    2) Proper naming of files, variables, functions, classes, tables,
    columns, views and all other artifacts
    3) Layer your application - each layer must address a specific
    concern
    4) Abstract common stuff into reusable utility classes

    Any help will be greatly appreciated
    (A positive response to this post & I promise I will contribute to
    the community by replying to at least 10 threads!)

  2. #2
    Registered User C_ntua's Avatar
    Join Date
    Jun 2008
    Posts
    1,853
    5) Optimizing. Make sure the avoid doing complicated optimizations from the beginning, but also for them to know the general cost of a function and not use too costly functions in a big loop.

    6) Memory management. Make sure the use when possible things like a vector and for their class to handle memory more dyanamic, typically making classes that free everything in their destructors or using vector instead of "new array". In general, automatic memory management is more reliable.

    7) Design and then implement. Similar to 4). Make sure they plan their classes first before starting implementing anything to avoid changing things later on all the time which result in nasty bugs.

    8) Documentation and clarity. Putting comments when necessary. A UML diagram might be useful sometimes. Show an example on this on how "if you had documented your code you would have avoided this and that". Mostly to keep track on the big picture since a lot lose track after a couple of weeks on what they have done here and there. Their code should be clear, avoid using complex statements in order to avoid allocating some variables things like fun1(fun2(), fun3(fun4()), fun5()); etc etc

  3. #3
    C++ Witch laserlight's Avatar
    Join Date
    Oct 2003
    Location
    Singapore
    Posts
    28,413
    If you are talking with respect to C++, which I presume is the case since you posted on this forum, then check out Sutter and Alexandrescu's C++ Coding Standards. A substantial portion of the material is specific to C++, but the chapters on "organizational and policy issues", "design style", "class design and inheritance" and some of "coding style" contain material that is more widely applicable.
    Quote Originally Posted by Bjarne Stroustrup (2000-10-14)
    I get maybe two dozen requests for help with some sort of programming or design problem every day. Most have more sense than to send me hundreds of lines of code. If they do, I ask them to find the smallest example that exhibits the problem and send me that. Mostly, they then find the error themselves. "Finding the smallest program that demonstrates the error" is a powerful debugging tool.
    Look up a C++ Reference and learn How To Ask Questions The Smart Way

Popular pages Recent additions subscribe to a feed

Similar Threads

  1. Senior Software Engineer - Client Apps
    By iwannawork in forum Projects and Job Recruitment
    Replies: 0
    Last Post: 06-17-2010, 10:07 PM
  2. Software Design/Test - Redmond, WA
    By IRVolt in forum Projects and Job Recruitment
    Replies: 2
    Last Post: 06-11-2008, 10:26 AM
  3. Why C Matters
    By DavidP in forum A Brief History of Cprogramming.com
    Replies: 136
    Last Post: 01-16-2008, 09:09 AM
  4. Replies: 28
    Last Post: 07-16-2006, 11:35 PM
  5. NAQ: Everything you never wanted to know about CPP
    By evildave in forum C Programming
    Replies: 21
    Last Post: 12-12-2005, 10:56 AM

Tags for this Thread