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.

74 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
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
  • 2,007
  • 16
  • 24
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
  • 237
  • 3
  • 7
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
5
votes
2 answers

What documentation should an engineer produce for communicating with other people?

Im soon to be developing a product on my own, for possible or sale or given away(open source as such). But I am struggling with the "internal" documentation that I should produce. What documentation needs to be produced with in companies for…
Dean
  • 8,448
  • 27
  • 72
  • 120
3
votes
2 answers

How to draw digital timing diagrams for documentation?

I have read through many electronics documentation over the years and I have really wanted to draw the timing diagrams for digital signals using some software. I have seen https://wavedrom.com/tutorial.html and their diagrams seem very detailed and…
Ativerc
  • 31
  • 1
  • 2
2
votes
2 answers

How to document protocol changes across firmware

I have updated the firmware on my device to accept new commands. How do I make it clear to other developers that the new protocol document is specific to this recent version? Should I make it clear which commands are reverse compatible in the new…
peteey
  • 411
  • 1
  • 4
  • 10