I just published an article in our quarterly Instrumentation Newsletter entitled 5 Things Test Engineers Should Know About Software. This article is just a basic introduction to many of the topics that are often discussion on this community and in the ni.com/largeapps white papers.
To summarize my points in the article:
- If you are not using source code control, you are playing with fire.
- Development without requirements is prototyping.
- You can measure the testability and quality of code.
- You may think your code works, but can you prove it?
- Reuse is not a myth, but it requires planning.
This is by no means an exhaustive list of things you should know, but it represents a short-list of things that are often overlooked, especially when people are using LabVIEW.
I also recently put together a list of mistakes I see made by many users, over and over again. These are all common examples that can lead to the duct-tape and hot-glue block diagram that we’ve all seen before. As engineers, we all appreciate the cost of cutting-corners or taking a short-cut… it may get us there sooner, but at what cost? In the world of software, there’s a concept known as ‘Software Engineering Debt.’ If we cut corners, we take on more debt, and these are all examples of how we do that. The more debt we take on, the more interest we accumulate over time, and as we’ve all seen in the recent years, that debt can quickly pile up and accumulate a mountain of interest, making it more exponentially more expensive. If we wait to pay down that debt until after we release a version of the software to our customer, it’s going to painful and the bugs will be much more costly than if we’d caught them up front.
- No source code control (or Project) – if you’re not using it, you’re playing with fire. Even for a small project with one developer, these tools can save you a tremendous amount of time and heartache.
- Flat file hierarchy – ever had trouble identifying the top-level VI in an application? It’s not just an organizational problem, it indicates a lack of encapsulation and proper design. Use folders, encapsulate your code and make APIs obvious from private subVIs
- ‘Stop’ isn’t tested regularly – there are lots of ways to assess the health of an application, but this is an easy one that you should always be thinking about. A new feature is no good if it impedes expected behavior and one key indicator is whether or not the application still stops instantly when asked to
- Wait until the ‘end’ of a project to build an application – if you’re one of those that waited until you were ‘done’ to build an exe for the first time, you’re probably a long ways away from done. The reality is that, as with any language, a lot of things change in the RTE, and you need to test this on a regular basis
- Few specifications / documentation / requirements – this is perhaps the most common mistake and the easiest way to ensure that code is not reusable or maintainable
- No ‘buddying’ or code reviews – sometimes the mere act of explaining your code to someone else finds major problems or bugs… do it, and do it often
- Poor planning (Lack of consideration for SMoRES) – This acronym stands for ‘Scalable,’ ‘Modular,’ ‘Reusable,’ ‘Extensible,’ and ‘Simple.’
- No test plans – you can’t test code if you don’t define how it should behave.
- Poor error handling – does it stop? Does it tell the user an error? Does it log the error? If you don’t plan for this early, a simple error can lead to even more problems
- No consistent style = not readible, not maintainable
- Tight coupling, poor cohesion – impedes reuse