Software Development

Best Practices Ever for Software Development

  1. Write programs for people, not computers.
    • a program should not require its readers to hold more than a handful of facts in memory at once
    • names should be consistent, distinctive and meaningful
    • code style and formatting should be consistent
    • all aspects of software development should be broken down into tasks roughly an hour long
  2. Automate repetitive tasks.
    • rely on the computer to repeat tasks
    • save recent commands in a file for re-use
    • use a build tool to automate scientific workflows
  3. Use the computer to record history.
    • software tools should be used to track computational work automatically
  4. Make incremental changes.
    • work in small steps with frequent feedback and course correction
  5. Use version control.
    • use a version control system
    • everything that has been created manually should be put in version control
  6. Don’t repeat yourself (or others).
    • every piece of data must have a single authoritative representation in the system
    • code should be modularized rather than copied and pasted
    • re-use code instead of rewriting it
  7. Plan for mistakes.
    • add assertions to programs to check their operation
    • use an off-the-shelf unit testing library
    • use all available oracles when testing programs
    • turn bugs into test cases
    • use a symbolic debugger
  8. Optimize software only after it works correctly.
    • use a profiler to identify bottlenecks
    • write code in the highest-level language possible
  9. Document design and purpose, not mechanics.
    • document interfaces and reasons, not implementations
    • refactor code instead of explaining how it works
    • embed the documentation for a piece of software in that software
  10. Collaborate.
    • use pre-merge code reviews
    • use pair programming when bringing someone new up to speed and when tackling particularly tricky problems

The only extra I would have included would be:

11. Maintain and update older code.

Reference: Best Practices Ever for Software Development from our JCG partner Andriy Andrunevchyn at the Java User Group of Lviv blog.

Bohdan Bandrivskyy

I have more then 8 years experiences as software developer. Last 7 years it's mainly java and java related technologies. Java fan :) and JUG Lviv participant and co-promoter
Notify of

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Newest Most Voted
Inline Feedbacks
View all comments
11 years ago

Kept it very simple. Worth reading. Thanks author.

Konstantin Ignatyev
11 years ago

Very good summary, and the best part is that author did not make it into 1.5 hour video! :)

Abhishek Anne
Abhishek Anne
11 years ago

Liked +1

Bohdan Bandrivskyy
11 years ago

Actually it’s also re-post from this blog :)

Arcisphere Tech
11 years ago

Bookmarked! It pays to be reminded of these simple list of best practices every now and then. Thanks for sharing, Bohdan. Cheers!

9 years ago

Great post! Love the point about refactoe code instead of trying to explain what it does

Back to top button