What are the best practices for documenting electrical testing and troubleshooting procedures?

1 Why document?

Documenting electrical testing and troubleshooting procedures is not only a good engineering practice, but also a legal and ethical obligation. Doing so can help you comply with codes, standards, and regulations that require records for electrical systems and equipment, as well as demonstrate due diligence and accountability for your work. It can also help you communicate clearly with your team, clients, stakeholders, and authorities to avoid misunderstandings, errors, or delays. Furthermore, documenting your procedures can improve your knowledge, skills, and performance, while enhancing your reputation and credibility as a professional facilities engineer.

2 How to document?

Documenting electrical testing and troubleshooting procedures can be done in various formats and methods, depending on the project’s nature, scope, and complexity. However, there are some general guidelines that apply to most situations. For instance, standard templates and forms should be used to capture relevant information, such as test or troubleshooting objectives, methods, equipment, results, observations, recommendations, actions, and signatures. Additionally, industry best practices and norms for electrical testing and troubleshooting documentation should be followed (e.g. IEEE standards, NFPA 70E, NETA guidelines or IEC standards). Clear, concise and accurate language should be used to avoid jargon or ambiguity; appropriate units, symbols, abbreviations and formats for numerical data should also be included (e.g. voltage, current, resistance or frequency). Diagrams, charts, graphs, photos or videos can supplement written documentation by illustrating the electrical system or equipment layout, connections, components or measurements. Lastly, references and sources should be included for any external information or data that is cited (e.g. manuals, specifications codes or publications).

3 When to document?

Documenting electrical testing and troubleshooting procedures should be done throughout the project lifecycle, from the planning and design phase to the commissioning and maintenance phase. Before beginning any testing or troubleshooting activities, it is important to establish the baseline conditions, parameters, and expectations for your work. During the process of testing or troubleshooting, you should record the actual data, observations, and outcomes of your work. After completing the activity, analyzing the data, drawing conclusions, making recommendations, and taking actions based on your work are all essential components of documenting your procedures.

5 How to review?

Reviewing electrical testing and troubleshooting documentation is a critical step that verifies the validity, accuracy, and completeness of your records. It should be reviewed by yourself to check for any errors, omissions, inconsistencies, or discrepancies in your records and make corrections. Additionally, you should have your peers, supervisors, or experts review your records to gain feedback, suggestions, or approval. Lastly, review by clients, stakeholders, or authorities can demonstrate compliance, accountability, or performance for your work and meet their expectations and requirements.