×
INTELLIGENT WORK FORUMS
FOR ENGINEERING PROFESSIONALS

Log In

Come Join Us!

Are you an
Engineering professional?
Join Eng-Tips Forums!
  • Talk With Other Members
  • Be Notified Of Responses
    To Your Posts
  • Keyword Search
  • One-Click Access To Your
    Favorite Forums
  • Automated Signatures
    On Your Posts
  • Best Of All, It's Free!
  • Students Click Here

*Eng-Tips's functionality depends on members receiving e-mail. By joining you are opting in to receive e-mail.

Posting Guidelines

Promoting, selling, recruiting, coursework and thesis posting is forbidden.

Students Click Here

Jobs

Documentation of Electrical/Electronic Design Intent

Documentation of Electrical/Electronic Design Intent

Documentation of Electrical/Electronic Design Intent

(OP)
This doesn't apply to GD&T, but I am hoping there are some standards to cover this topic.

I'm looking for ways to reduce the number of calls from field service techs contacting Engineering everytime there is an electrical connection or electronic controller issue with our products in the field.

We provide basic system block diagrams (interconnection diagrams) and wiring diagrams.  We also have production harness drawings available.  We develop and manufacture our own controllers, PCBs, and software logic.

Since we are predominately a manufacturing company of transit equipment, the electronics and electrical is always the "red-headed step child" of the company.  I'm looking for advice on what details or other documents we should be creating.  For starters, we list (or name) the inputs/outputs of our controllers, but never provide information as to what conditions are required to get the proper input/output.

"I think there is a world market for maybe five computers."
Thomas Watson, chairman of IBM, 1943.
Have you read FAQ731-376 to make the best use of Eng-Tips Forums?

RE: Documentation of Electrical/Electronic Design Intent

We use DS (Design Specification) documents that go with PCB's. It would go with the drawing and match the part number, i.e. DS12345.
This doc tells them everything they need to know to build, test, program, etc.

Chris
Sr. Mechanical Designer, CAD
SolidWorks 05 SP3.1 / PDMWorks 05
ctopher's home site (updated 06-21-05)
FAQ559-1100
FAQ559-716

RE: Documentation of Electrical/Electronic Design Intent

The best service schemaics I've seen include little 'scope' drawings of expected waveforms for analog signals at important points, expected voltages at various pins where they're not obvious, text descriptions of what each block is supposed to do, photos with arrows showing you where to hook up to test and adjust things, stuff like that.  

Ideally, a tech should be able to evaluate the operational state and health of the block he's looking at, without _ever_ referring to an interconnect diagram to find out what's at the other end of every wire he can see.

It may well be possible, but I've never seen a design operation generate drawings like that.  Your own service department may have ugly home- grown paste-ups that will knock your socks off for their clarity.  If they don't, study the SAMS manuals for some things you think you understand.

One way to get started is to log, record, and analyze the incoming phone calls with an eye to understanding why the guy who's out there in the trenches didn't immediately grok what your stuff is trying to do, and what you would have to add to help him 'get it' right away.


Mike Halloran
Ft. Lauderdale, FL, USA

RE: Documentation of Electrical/Electronic Design Intent

In order to trouble shoot, a technician needs to understand what output to expect for any possible combination of inputs.

For simplistic control logic a classic flow chart may suffice.

For more complex control, state diagrams are extremely useful, once you learn how to use them properly.

The IEEE has some standards for software documentation.

The aircraft industry has some good standards for service manuals, I don't recall the acronym or number at the moment.

Red Flag This Post

Please let us know here why this post is inappropriate. Reasons such as off-topic, duplicates, flames, illegal, vulgar, or students posting their homework.

Red Flag Submitted

Thank you for helping keep Eng-Tips Forums free from inappropriate posts.
The Eng-Tips staff will check this out and take appropriate action.

Reply To This Thread

Posting in the Eng-Tips forums is a member-only feature.

Click Here to join Eng-Tips and talk with other members!


Resources