Electrical Engineering Stack Exchange
Electrical Engineering Stack Exchange

Questions tagged [documentation]

Documents which explain the function(s), use, limitations, specifications, etc. of an electrical component. Examples include datasheets, schematics, user manuals, etc.

Documents which explain the function(s), use, limitations, specifications, etc. of an electrical component. Examples include datasheets, schematics, user manuals, etc.

72 questions
50
votes
7 answers

What should a contract Electrical Engineer deliver once a project is complete?

I'm getting ready to hire an electrical engineer for a small contract job - creating a prototype. What I'd like to know is, what should I have him deliver to me when the project is complete? I imagine schematics, the prototype, parts list would be…
Adam
  • 253
  • 4
  • 5
46
votes
7 answers

How do you document your hardware design decisions?

How do you document your hardware decisions in the design phase? How do you avoid having to ask yourself the following questions while reviewing an hardware design that you made in the past: Why did a choose this component? Why/how did I choose…
m.Alin
  • 10,638
  • 19
  • 62
  • 89
25
votes
6 answers

How to Transition from "Basic" Microcontrollers to ARM Cortex?

I have many years of experience with 8-bit cores from various manufacturers - namely 8051, PIC, and AVR - and I now have a Cortex M0 to figure out. Specifically this one, but I hope we can be more general than that. It's turning out to be a bit…
AaronD
  • 5,596
  • 10
  • 36
16
votes
7 answers

What process do you use to ensure your PCB works on the first try?

What are the best practices for catching stupid mistakes vs more subtle ones? Do you run over a checklist of things for each design? If so, what kinds of things are on it? I'm interested in manufactured PCBs, as if a co-worker gave you a schematic…
aloishis89
  • 1,660
  • 3
  • 13
  • 20
13
votes
5 answers

Why put unpopulated components on a BOM?

I've ran into quite a few engineers from unrelated backgrounds that put unpopulated components on the BOM. Some will do a section clearly labelled DNP at the bottom, others will leave them dispersed throughout the BOM, but highlight the rows.…
Matt Young
  • 13,734
  • 5
  • 34
  • 61
13
votes
3 answers

What is *actually* a *standard part*?

This is something that has bothered me for ages. I wasn't sure it could be made up as a question here, until Olin Lathrop suggested it to me in a comment to another thread. We all know what we are talking about when someone mentions, for example, an…
LorenzoDonati4Ukraine-OnStrike
  • 24,350
  • 5
  • 62
  • 107
10
votes
2 answers

How make hardware documentation?

I'm building some slides for my class about how we should document the hardware we are developing. I'd like to list the documents we should make when building some hardware. I was inspired at UML software documentation, which brings lots of document…
RMAAlmeida
  • 1,997
  • 15
  • 24
9
votes
1 answer

What are your best resources for winding custom transformers?

What are the best resources that you have found for winding custom transformers? prose, videos, forums, etc. I am looking for things more on the practical side rather than resources explaining the basics of transformer winding ratios. Once I get…
Napthali
  • 265
  • 1
  • 8
8
votes
3 answers

How to correctly fill a BOM with split connectors

I have to prepare the documentation for production. In our board we use a specific female header with 6 positions. Long story short, the buyer guys told me we will buy a 64-way connector and then it will be split…
Mark
  • 1,161
  • 6
  • 23
7
votes
2 answers

What does apostrophe mean for a register description in a datasheet e.g. 4'd5?

The datasheet lists something like this: [0x01f] EPRXREG EPRXLock[3:0] = 4'd5; EPRXReLock[3:0] = 4'd5 I understand that it is an 8-bit register at address 0x01f, it contains 2 fields and each of them is 4 bits wide ([3:0] and the 4 in…
xealits
  • 227
  • 3
  • 7
7
votes
2 answers

Online guide to electronics

I had the luck to have someone who could explain everything to me, but most starting hobbyists don't have someone like that. Is there a guide available which covers all the basics, like formulas, parallel / series, etc.?
user17592
7
votes
6 answers

Text presentation of a byte

I've seen in a lot of projects a cool presentation of byte such as : Fuse high byte: 0xc9 = 1 1 0 0 1 0 0 1 -- BOOTRST (boot reset vector at 0x0000) ^ ^ ^ ^ ^ ^ ^------ BOOTSZ0 | | | | | +--------…
jojo l'abricot
  • 261
  • 3
  • 7
7
votes
3 answers

How do you document bodges?

After making the PCBs, we decided on some bodges and implemented them on the PCBs. What's the standard way to document that on the schematics? For now, I hand drew with the mouse, paint style, on the schematics PDF files, to convey the idea that…
nraynaud
  • 649
  • 6
  • 14
7
votes
2 answers

Best practices in making cable schematics

I would like to make cable schematics for manufacturing that would include: cable lengths connectors pins conduit length heat shrink tube length and have a BOM for that automatically generated in Altium/Eagle. That that would require every element…
mactro
  • 487
  • 5
  • 14
6
votes
5 answers

Best practice for documenting ports / peripherals?

I've recently taken an interest in embedded development and am wondering how most people document their projects. For example: Each pin on PORTE is wired to an LED and is aliased as LEDPORT. Methods related to the LED functionality is located in…
RubberDuck
  • 260
  • 1
  • 10
1
2 3 4 5