CONTROL PANELS DESIGN

TECHNICAL WRITING

COMPANIES:

Siemens - OEM Product Manual Tokyo Electron:
TEL AC box I and II

Siemens - IGBT controls fault diagnostic software.

DATE: 1995-1997

NEW PRODUCT prototype: Switchgear

POSITION: MV drives: Systems Engineer

Microsoft Compiled HTML Help is a Microsoft proprietary online help format, consisting of a collection of HTML pages, an index and other navigation tools. The files are compressed and deployed in a binary format with the extension .CHM, for Compiled HTML. The format is often used for software documentation.

Many software programs have online help systems based on the "CHM" model. To the right is an example . you may already be familiar with the format. It offers many possibilities other than help systems. So i decided to use it to create our Product OEM manual to save costs. Simplify creation and offer the advantages of a HTML help format.

There is an expandable panel for navigation between topics and using search features.All document information is usually contained in the central panel.

All document information is usually contained in the central panel.

THE SIDE PANEL ALLOWS FOR USE OF TWO TABS FOR SEARCHING THE ENTIRE DOCUMENT SET BY BOTH TOPIC/ CHAPTER AND ALSO A "KEY WORD" INDEX.

HERE IS AN EXAMPLE OF THE HTML OEM MANUAL WE CREATED. i DID SOME TECHNICAL WRITING AS NEEDED BUT AGAIN MOST TECHNICAL INFORMATION WAS SUPPLIED BY SUBJECT MATTER EXPERTS. BUT THIS DEMO IS JUST TO EXPLAIN WHAT A CHM IS AND WHAT INFORMATION CAN BE INTEGRATED. WE THEN SUPPLIED THIS RATHER THAN PRINTING HARD COPY MANUAL MAKING CORRECTIONS AND UPDATES EASIER. LESS PAPER AND COSTS IN PRINTING AND BINDING THE MANUALS AND THE ABILITY TO DELIVER AN UPDATE VIA EMAIL RATHER THAN SHIPPING AND HANDLING CHARGES. THIS WAS 1996-7 SO IT WAS A FAIRLY NEW INNOVATION BACK THEN.

MAKING CORRECTIONS AND UPDATES EASIER. LESS PAPER AND COSTS IN PRINTING AND BINDING THE MANUALS AND THE ABILITY TO DELIVER AN UPDATE VIA EMAIL RATHER THAN SHIPPING AND HANDLING CHARGES. THIS WAS 1996-7 SO IT WAS A FAIRLY NEW INNOVATION BACK THEN. HERE IS THE TABLE OF CONTENTS SUCH THAT A CHANGE HERE COULD AFFECT THE ENTIRE MANUAL AND PAGE NUMBERING. ELECTRONIC COPIES WERE SIMPLER TO MANAGE.

HERE IS AN EXAMPLE OF GENERAL TOPIC INFORMATION. THE VIEW IS A LITTLE BLURRED IN THESE NOT TO DISCLOSE AND INFORMATION WHICH MAY BE PROPRIETARY AND PROTECT THE RIGHTS OF MY FORMER EMPLOYER.

HERE IS AN EXAPMLE OF A FLOW CHART FOR TROUBLE SHOOTING OPERATION OF THE ELECTRICAL PANEL.

HERE IS A CHART FOR FAULT RECOVERY OF EACH DEVICE WITHIN THE CONTROL PANEL. FOR USE BY MAINTENANCE AND COMMISSIONING PERSONAL SO THE CLIENT COULD BE ABLE TO TROUBLE SHOT AND RECOVER FROM SIMPLE FAULTS WITHOUT NEED FOR A SERVICE CALL.

HERE IS AN EXTERNAL VIEW OF THE PANEL AND A BILL OF MATERIAL FOR ALL PARTS AND THEIR LOCATION IN THE MACHINE.

THIS WOULD BE THE CONTROL SYSTEMS SCHEMATICS FOR VISUAL UNDERSTANDING OF CIRCUITRY AND COMPONENTS LAYOUT. THE BOOK CONTAINED A LAYOUT OF THE PLACEMENT OF THE INTERNAL ELECTRICAL CONTROL COMPONENTS AND BILL OF MATERIAL AS WELL.

PRETTY MUCH EVERYTHING NEED TO MAINTAIN AND TROUBLE SHOOT THE ENTIRE SYSTEM FOR SIMPLE REPAIRS AND MAINTENANCE IS INCLUDED IN THE MANUAL. THINGS THAT ARE CONSIDERED MORE PRECISION OR DANGER IS INVOLVED IS STILL REFERRED BACK TO OUR COMPANY FOR A SERVICE ALL. SO DISTRIBUTION OF DOCUMENTS OVER HARD COPIES PROVED MORE EFFICIENT AND COST SAVINGS. THIS WAS 1996. SINCE THEN THIS HAS BECOME PRETTY MUCH THE STANDARD FOR DOCUMENTATION BUT I WAS IN THERE AMONG THE 1ST FOR MAJOR INDUSTRIAL CONTROLS COMPANY..