Chapter 10
Electrical and Electronic Engineering Documentation
Bachelors Program in Electrical Engineering
Engineering Drawing & Design
•
Bachelor
Electrical and Electronic Engineering Documentation
Introduction and Context
Electrical engineering drawings communicate how equipment is structured, connected, installed, tested, operated, and maintained. Unlike pictorial illustrations, engineering documents are controlled technical specifications. Their value depends on standardized symbols, unambiguous references, logical arrangement, revision control, and consistency between related documents.
A power-system engineer may use a single-line diagram to show the flow of electrical energy; a control engineer may use a schematic to explain circuit logic; an installation technician may require a wiring diagram and terminal plan; and a manufacturing engineer may use a panel layout and cable schedule. These documents describe different views of the same engineered system. Effective documentation therefore requires both drawing skill and systems thinking.
Standards vary by jurisdiction and organization. Commonly encountered frameworks include IEC 60617 for graphical symbols, IEC 61082 for preparation of electrotechnical documents, IEC 61355 for classification and designation of documents, IEC 81346 for reference designations, IEEE and ANSI practices, and National Electrical Code requirements in the United States. A project must identify the governing standard and apply it consistently; symbols should not be copied from unrelated conventions without verification.
Learning Objectives
By the end of this chapter, the student should be able to:
Interpret the functional and physical information contained in engineering drawings.
Prepare a coordinated documentation set for a small electrical installation.
Explain design verification, safety, revision control, and documentation responsibilities.
Describe the purpose and limitations of introductory printed-circuit-board documentation.
1. Documentation as a System of Representations
A drawing is a model of a real system. Every model omits some information and emphasizes other information. A block diagram emphasizes function and signal or energy flow. A panel layout emphasizes physical location. A schematic emphasizes logical or electrical relationships. Confusing these purposes is a common source of installation and maintenance errors.
Documentation can be considered in four complementary dimensions:
Dimension
Main question
Typical document
Function
What does the system do?
Block diagram
Circuit logic
How are components electrically related?
Schematic
Physical arrangement
Where is each item installed?
Panel layout
Installation interface
Which conductor connects to which point?
Wiring diagram, terminal plan, cable schedule
A complete package normally includes a title block, drawing number, revision, date, author and checker, page number, project identification, applicable standards, notes, and a controlled list of associated documents. The drawing should be usable without relying on the memory of its creator.
1.1 Graphic conventions
Lines should be legible, continuous where an uninterrupted connection is intended, and interrupted only with a recognized convention. Junction dots or explicit connection marks distinguish joined conductors from crossing conductors. Arrows indicate signal, energy, or reference direction only when their meaning is defined. Text should be horizontal where possible, consistently sized, and placed so that it cannot be mistaken for a wire or symbol.
Symbols represent function rather than artistic appearance. A resistor, switch, diode, relay contact, motor, transformer, fuse, earth connection, connector, and integrated circuit each have recognized graphical forms. If a special symbol is unavoidable, it should be defined in a legend and used consistently.
Reference designations identify instances of equipment. Examples include R1 for a resistor, C3 for a capacitor, D2 for a diode, K1 for a relay or contactor, M1 for a motor, T1 for a transformer, F1 for a fuse, TB1 for a terminal block, and X1 for a connector. The exact scheme may differ by standard or company practice; consistency and uniqueness are essential.
2. Principal Document Types
2.1 Block diagrams
A block diagram represents major functional units using labeled rectangles or other simple shapes. Lines show information, energy, or material flow. Internal circuitry is intentionally omitted. For example, a regulated power supply may be represented as:
Functional block diagram of a regulated power supply
Figure: Functional block diagram of a regulated power supply
Figure: Functional block diagram of a regulated power supply.
Block diagrams are valuable during requirements definition, system architecture, troubleshooting, and communication with non-specialists. They do not prove that a circuit is electrically safe or that every conductor has been specified.
2.2 Single-line diagrams
A single-line diagram (SLD) represents a multiphase power system with one line for a circuit, together with symbols and annotations that identify phases, ratings, protection, transformers, buses, loads, and earthing. It is especially useful for distribution systems because drawing every phase would obscure the topology.
An SLD should identify nominal voltage, frequency where relevant, equipment ratings, protective-device ratings, conductor information, transformer ratios, fault-level data when required, and points of isolation. A line shown on an SLD is not necessarily one physical conductor. The drawing must state the interpretation of the line and any phase or pole information.
For a balanced three-phase load, apparent power is commonly related to line voltage and line current by:
S = √3 VL IL
Here S is apparent power in volt-amperes, VL is line-to-line RMS voltage in volts, and IL is line current in amperes. The relation assumes a balanced three-phase system and RMS quantities. For a single-phase circuit, the corresponding relation is S = V I. Real power is:
P = √3 VL IL cosφ
where P is real power in watts and cosφ is the power factor. These equations may support annotation and checking, but ratings must also comply with applicable installation rules, thermal limits, voltage-drop requirements, and protection coordination.
2.3 Schematics
A schematic shows electrical relationships rather than physical position. It is usually arranged so that power progresses from left to right or top to bottom, while control logic is grouped by function. Contacts are normally shown in their de-energized or normal state unless the drawing explicitly states otherwise. This convention is critical: a normally open contact and a normally closed contact do not describe the state of an energized machine; they describe the defined reference state.
A motor-starting control schematic may contain a control fuse, stop contact, start contact, contactor coil, auxiliary holding contact, overload contact, and indication lamps. The schematic should show coil and contact references, conductor identifiers, terminal numbers, and cross-references between pages.
Electronic schematics add polarity, signal names, component values, package references, test points, and net labels. A net label such as +5 V, GND, RESET, or ADC_IN must be unique or intentionally connected. Components should have both a reference designation and a value or part description, such as R4, 10 kΩ, or U2, microcontroller.
2.4 Wiring and interconnection diagrams
A wiring diagram describes point-to-point conductors. It may show the actual terminal or connector numbers, wire numbers, conductor colors, sizes, and destinations. An interconnection diagram emphasizes connections between assemblies, such as a control panel, motor, field sensor, and remote cabinet.
A schematic answers “what is electrically connected?” A wiring diagram answers “which physical wire is installed between which terminals?” A technician should not be expected to infer a terminal number from a symbol that has not been assigned one.
2.5 Panel layouts
A panel layout is a scaled or dimensioned physical representation of an enclosure, cabinet, or control station. It shows mounting plates, door devices, circuit breakers, contactors, relays, power supplies, programmable controllers, ducts, gland plates, and clearance zones. It should identify dimensions, mounting-hole patterns, heat-producing equipment, access requirements, segregation of power and control wiring, and ingress-protection considerations.
The layout must be coordinated with the enclosure specification and manufacturer data. A symbol that fits graphically may not fit physically. Space for bending radius, ventilation, tool access, spare terminals, and future maintenance is part of design quality.
2.6 Terminal plans and cable schedules
A terminal plan lists terminal blocks and the circuits connected to them. A useful terminal plan includes terminal number, wire number, destination, signal description, terminal type, and, where necessary, fuse or disconnect function.
A cable schedule identifies cables between equipment. Typical fields are cable number, from, to, service, cable type, number and size of cores, screen or armour, route, gland, and termination information. Cable schedules support procurement, installation, testing, and maintenance. They should not contradict wiring diagrams or equipment lists.
3. Symbols, References, and Information Hierarchy
A documentation set should distinguish three kinds of identification:
Device designation: identifies a physical or logical component, such as K1.
Connection designation: identifies a terminal, pin, or net, such as K1:13 or X2:4.
Conductor designation: identifies a wire or cable core, such as W017 or C-03/2.
A practical naming system is hierarchical. For example, panel CP-01 may contain terminal block TB1, terminal 12, connected to wire W034, which forms core 2 of cable C07 and terminates at field device LS-01. The same relationship should be traceable from the schematic, wiring diagram, terminal plan, and cable schedule.
Cross-references are particularly important for relay contacts, multi-page circuits, connectors, and off-page connections. A contact labelled K1-13/14 should be traceable to coil K1. A connector should identify pin numbering and the viewing orientation; otherwise a drawing can be electrically correct but physically ambiguous.
4. Preparing a Coordinated Documentation Set
A disciplined workflow is more reliable than drawing individual pages in isolation.
Step 1: Establish requirements and conventions
Define system boundaries, supply characteristics, operating modes, applicable codes, document numbering, symbol standard, reference-designation rules, and revision procedure. Record assumptions, such as whether a protective earth is supplied through a cable or bonded locally.
Step 2: Develop the functional architecture
Create the block diagram and identify sources, loads, control functions, interfaces, safety functions, and external systems. Confirm that every required function has an identifiable block and that information or energy flows are sensible.
Step 3: Develop the power architecture
Prepare the SLD, showing incomers, isolation, distribution, protective devices, transformers, drives, loads, earthing, and relevant ratings. Check that the stated voltage and current relationships are consistent. Protection selection requires more than nominal current; interrupting capacity, discrimination, installation method, and local regulations must also be considered.
Step 4: Develop detailed schematics
Separate power, control, safety, instrumentation, and electronic circuits where this improves clarity. Use stable page structures, signal names, cross-references, and normal-state conventions. Avoid unnecessary wire crossings and repeated unlabeled connections.
Step 5: Convert logical connections into installation information
Assign terminals, wire numbers, cable cores, connector pins, and physical destinations. Generate or check the terminal plan, wiring diagrams, cable schedule, and equipment list.
Step 6: Produce panel and equipment layouts
Use actual manufacturer dimensions and mounting information. Verify clearances, heat dissipation, cable entry, separation, accessibility, and serviceability. Match each layout reference to the schematic reference.
Step 7: Verify and issue
Perform independent checking, electrical rule checking where available, cross-document comparison, and a physical design review. Freeze the issue only after discrepancies are resolved. Record the revision description and approval status.
5. Worked Application: A Small Pump-Control Panel
The following is an illustrative case, not a substitute for a site-specific design or regulatory approval.
Background and problem
A water tank requires a pump motor controlled by a low-level float switch and a high-level float switch. The panel contains a main isolator, motor protective device, contactor K1, overload relay, 24 V DC control supply, start/stop logic, run indication, and terminals for field devices. The pump must stop on overload and must not run when the tank is empty.
Analysis
The functional blocks are supply, protection, control power, level sensing, motor switching, and motor load. The principal hazards are unexpected starting, loss of protective bonding, incorrect float interpretation, and inability to isolate the motor. The documentation must make the safe state and field interfaces clear.
Documentation approach
The block diagram shows the functional chain. The SLD shows the incoming supply, isolator, protective device, contactor, overload, and motor. The control schematic shows a stop or emergency-stop contact in series with the contactor coil, the overload auxiliary contact, and the level-control logic. The wiring diagram identifies every panel terminal and field conductor. The panel layout places the isolator and operator devices where they are accessible, separates power and control wiring, and leaves space around the motor starter. The terminal plan assigns distinct terminals for the two float switches, motor conductors, protective earth, and 24 V control supply.
A simplified terminal schedule might be:
Terminal
Function
Destination
TB1-1
24 V DC supply +
Control supply
TB1-2
0 V DC
Control supply
TB1-3
Low-level switch input
LS-01
TB1-4
Low-level switch return
LS-01
TB1-5
High-level switch input
LS-02
TB1-6
High-level switch return
LS-02
TB1-7
Motor phase U
M1
TB1-8
Motor phase V
M1
TB1-9
Motor phase W
M1
TB1-10
Protective earth
M1 frame
The final design must define whether a level switch is normally open or normally closed, what state represents a broken conductor, and whether loss of the 24 V supply causes a safe stop. These are functional-safety decisions, not merely drafting details.
Verification and outcome
The checker traces each terminal from field device to schematic, confirms that K1’s auxiliary contact is referenced correctly, verifies that the overload contact interrupts the coil circuit, and confirms that the isolator disconnects the required conductors. A simulated wire break at the low-level switch is reviewed for its effect. The coordinated package allows an installer to build the panel, a tester to perform point-to-point checks, and a maintainer to locate the relevant circuit quickly.
Learning points
The case demonstrates that no single drawing is sufficient. The block diagram explains purpose, the SLD explains power distribution, the schematic explains logic, and installation documents explain physical realization. Safety depends on their agreement and on explicit assumptions about normal states and failure behavior.
6. Introductory PCB Documentation
Printed-circuit-board documentation adds a physical electronic implementation to the schematic. The schematic defines nets and components; the board layout defines component placement, copper tracks, planes, vias, mounting holes, silkscreen, and manufacturing constraints.
A basic PCB documentation package may include:
schematic source and released schematic PDF;
bill of materials with reference, value, footprint, and approved part;
netlist or native design database;
board outline and mechanical drawing;
fabrication outputs such as Gerber or ODB++ files;
drill files and fabrication notes;
assembly drawing, pick-and-place data, and assembly notes;
test-point list and programming or configuration information.
The schematic symbol and PCB footprint must correspond correctly. Pin numbering, polarity marks, first-pin indicators, connector orientation, and component reference text require deliberate checking. A diode or electrolytic capacitor with reversed polarity marking can create a serious assembly defect even if the schematic is correct.
Introductory layout decisions include clearance, creepage, trace width, return-current paths, thermal relief, separation between noisy and sensitive circuits, and mechanical fit. Trace width is not selected from appearance; it depends on current, allowable temperature rise, copper thickness, and manufacturing rules. High-voltage clearances and safety classifications must be determined from applicable standards and working conditions.
7. Quality, Safety, and Governance
Design checking
A robust check includes:
Symbol and reference uniqueness.
Correct polarity, contact state, and pin numbering.
Continuity between schematic, wiring, terminal, cable, and layout documents.
Correct ratings, units, and conductor identification.
Adequate protective-earth and bonding information.
Clear isolation points and warnings.
Revision, approval, and document-status accuracy.
Manufacturability, maintainability, and testability.
Revision control and configuration management
A drawing revision should identify what changed, why it changed, who made the change, who checked it, and when it became effective. Superseded drawings must be clearly withdrawn from the work area. Electronic files require controlled access, naming conventions, backups, and a reliable link between the released PDF and editable source.
Ethical and regulatory responsibilities
An engineer must not conceal uncertainty, omit a protective device to make a drawing appear simpler, or approve a document without adequate review. Drawings can affect shock, fire, machinery, and environmental risks. Local electrical codes, machinery safety requirements, EMC rules, hazardous-area classifications, and manufacturer instructions may impose requirements beyond drafting standards.
Computer-aided design and AI
CAD systems improve consistency through symbol libraries, templates, automatic numbering, cross-references, design-rule checks, and report generation. They do not guarantee engineering correctness. An AI tool may assist with symbol lookup, document comparison, or extracting a preliminary cable list, but generated content must be checked against authoritative standards, manufacturer data, and the actual design. Confidential project information and controlled intellectual property should not be uploaded to an unapproved service. Accountability remains with the qualified engineer and the organization issuing the document.
8. Common Errors and Best Practices
Common errors include mixing IEC and ANSI symbols without a legend, using a wire crossing as an implied junction, omitting terminal numbers, showing a relay contact without its coil reference, using inconsistent device names, failing to indicate normally energized states, and issuing a layout that does not match the installed hardware.
Best practice is to use a documented convention, maintain a single source of truth for device data, use meaningful hierarchical references, separate logical and physical views, provide cross-references, include legends and notes, and conduct both design review and installation feedback. Drawings should be tested by asking whether a competent person unfamiliar with the design can identify every connection, isolation point, hazard, and replacement component.
Chapter Summary
Electrical and electronic engineering documentation is a coordinated language for describing function, electrical relationships, physical arrangement, and installation interfaces. Block diagrams communicate architecture; single-line diagrams communicate power distribution; schematics communicate circuit logic; wiring and interconnection diagrams communicate point-to-point installation; panel layouts communicate physical arrangement; terminal plans and cable schedules communicate field interfaces. Introductory PCB documentation extends the same principles to electronic manufacturing.
Reliable documentation uses standardized symbols, unique references, explicit connection information, normal-state conventions, cross-references, controlled revisions, and independent verification. A drawing set is successful only when its documents agree and support safe design, construction, testing, operation, and maintenance.
Key Terms
Reference designation: A unique identifier assigned to a component or equipment item.
Block diagram: A high-level representation of functional units and their flows.
Single-line diagram: A simplified representation of a power system using one line for a circuit or multiphase group.
Schematic: A diagram showing logical or electrical relationships rather than physical position.
Wiring diagram: A document showing physical conductors and their connection points.
Interconnection diagram: A diagram showing connections between assemblies or equipment.
Panel layout: A physical arrangement of devices within an enclosure or panel.
Terminal plan: A structured record of terminal numbers and connected circuits.
Cable schedule: A list describing cables, routes, cores, destinations, and terminations.
Net: A set of electrically connected points in an electronic design.
Cross-reference: Information linking a device, contact, page, or related document to another location.
Normal state: The defined reference condition of a device, often de-energized or unactuated.
Protective earth: A conductor or connection intended to reduce electric-shock risk.
Revision control: The controlled recording and release of document changes.
Design rule check: An automated or manual check for specified drafting or electrical constraints.
Bill of materials: A structured list of components required to build an assembly.
Footprint: The physical PCB land pattern and outline associated with a component.
Creepage: The shortest distance along an insulating surface between conductive parts.
Clearance: The shortest distance through air between conductive parts.
Configuration management: Control of the identity, status, and changes of technical items.
Review Questions
Short Answer Questions
What is the principal difference between a schematic and a wiring diagram?
Why is a single-line diagram useful for a three-phase distribution system?
What information is normally included in a terminal plan?
What does a reference designation identify?
Why must a PCB footprint be checked against its schematic symbol?
Long Answer Questions
Explain how a block diagram, SLD, schematic, wiring diagram, and panel layout complement one another in a control-panel project.
Describe a professional workflow for producing and verifying a coordinated electrical documentation package.
Discuss the importance of normal-state conventions for relay contacts, switches, and safety circuits.
Explain the main contents and uses of a cable schedule and terminal plan.
Discuss ethical, regulatory, and configuration-management responsibilities associated with engineering drawings.
Analytical / Application Questions
A technician reports that the motor shown as stopped on a schematic starts unexpectedly after a control wire is disconnected. Identify documentation and design questions that should be investigated before modifying the circuit.
Develop a document set for a small 24 V sensor panel containing four sensors, a controller, a power supply, and a remote alarm. State what each document must communicate.
A PCB assembly repeatedly fails because a polarized capacitor is installed backward. Analyze how schematic symbols, footprint metadata, silkscreen, assembly drawings, and inspection procedures should be improved.
Multiple Choice Questions with Answers
Question 1
Which document primarily represents functional units and their signal or energy flow while omitting detailed circuitry?
A. Block diagram
B. Terminal plan
C. Panel layout
D. Cable schedule
Correct Answer: A. Block diagram
Question 2
In a single-line diagram, one line for a three-phase circuit generally represents:
A. Only the protective-earth conductor
B. The circuit or multiphase group in a simplified form
C. A guaranteed single physical wire
D. Only the neutral conductor
Correct Answer: B. The circuit or multiphase group in a simplified form
Question 3
Which document is most directly used to identify the physical terminal number for a field wire?
A. Block diagram
B. Functional specification
C. Terminal plan
D. Load-flow report
Correct Answer: C. Terminal plan
Question 4
A relay contact shown in its normal state is generally represented in the condition in which it is:
A. Energized and mechanically forced
B. De-energized or otherwise defined as the reference state
C. Short-circuited by the load
D. At maximum rated current
Correct Answer: B. De-energized or otherwise defined as the reference state
Question 5
For a balanced three-phase load, which expression gives apparent power using line quantities?
A. S = VL IL
B. S = 3 VL IL
C. S = √3 VL IL
D. S = VL/IL
Correct Answer: C. S = √3 VL IL
Question 6
Which item most directly describes the physical arrangement of devices inside an enclosure?
A. Panel layout
B. Netlist
C. Block diagram
D. Cable schedule
Correct Answer: A. Panel layout
Question 7
What is the principal purpose of a cross-reference for a relay contact?
A. To specify its paint color
B. To link the contact to the associated relay coil or related location
C. To replace the need for a terminal number
D. To state the enclosure weight
Correct Answer: B. To link the contact to the associated relay coil or related location
Question 8
Which PCB document normally lists component references, values, footprints, and approved parts?
A. Bill of materials
B. Single-line diagram
C. Terminal plan
D. Earthing layout
Correct Answer: A. Bill of materials
Question 9
A cable schedule is primarily concerned with:
A. Software source code
B. Cable identity, destinations, cores, routes, and terminations
C. Only the artistic appearance of a panel
D. The operating temperature of a building
Correct Answer: B. Cable identity, destinations, cores, routes, and terminations
Question 10
Why should AI-generated drawing information be independently checked?
A. AI output is automatically a legally approved design
B. AI cannot produce any text
C. Generated content may conflict with standards, manufacturer data, or the actual design
D. Checking is unnecessary when a drawing has a title block
Correct Answer: C. Generated content may conflict with standards, manufacturer data, or the actual design