|
Software Development
High Standard of Documentation and Source Code ReadabilityI have always strongly believed in the following rule:"Do it right the first time. Finish it properly. Document it properly. Only then do you move on." This takes discipline. Many young engineers don't follow this rule. They may be intellectually brilliant, but they throw themselves at the problem, do it at a lightning fast pace, and get distracted by the next job before they've even finished the first one. When they need to go back they have to do it all over again because they can no longer remember what they did the first time. I have always been able to go back to past work to make changes and improvements, even a decade or more after the code was first written. And if anything were to happen to me there is enough information in place for another engineer to pick up where I left off.
The code itself is heavily commented and is made as readable as possible. This is essential for maintenance. The following examples show the typical structure of software written by me, and the detailed level of commenting present:
Modular Software for Use in ApplicationsI maintain a library of general purpose software modules for use in my projects. There are literally hundreds of thousands of lines of original code that I have developed over the years. It can reduce development times for complex projects literally by years.
|
|
||||||||||||||||
|
All of my software is fully documented in separate word processor files.
This covers the software's architecture, detailed operation, function
call parameters and operation, and revision records.
