288: You Got a Screen!
Embedded10 Mai 2019

288: You Got a Screen!

Christopher (@stoneymonster) and Elecia (@logicalelegance) discuss embedded systems education and project documentation.

Elecia wrote about her love of notebooks on the https://www.embedded.fm/blog-index.

yEd, for when you don't have Visio. Asciiflow.com, for when you don't have yEd (or you want to put diagrams in your comments)

We talked about many different documents and tried to note design vs implementation, product vs engineering vs user, and why we wanted them. We didn't mention mechanical things because, ya know, software engineers. Some documentation we mentioned:

  • Product documentation

  • Schematics with block diagrams and comments. Also a GPIO to function spreadsheet.

  • UI flow when the system has a screens (Balsamiq for wireframe testing UIs)

  • SW spec and design doc: what do we plan to build and what are the tricky parts

  • SW configuration and SW developer docs: how to rebuild the computer that can build the code from scratch, also notes on debugging methodology

  • User manual: Usually not written by SW but may need SW's patient input

  • Code comments: Functions and files get 5Ws: who, what, why, when, where, and how.

    • Who should call this?

    • What will its effect be? ("What will it do" but not in line by line detail!)

    • How does it work?

    • Why does it work this way?

    • When should it be called?

    • Where are its parameters? ("What" works here too but "where" is nice to remind you to check your memory assumptions.)

  • Repository checkin comments

  • Style guide (Such as Google's or PEP)

  • Manufacturing docs and tests docs

Adafruit and Sparkfun both write good documentation, writing to users about how to use their code. Elecia likes Adafruit's sensor library as a good set of code to review (including how much is in their docs vs their code).

Episoder(567)

512: What if I Didn't Stop?

512: What if I Didn't Stop?

Katherine "Smalls" Connell spoke with us about making thin and flexible circuits, making stretchable electronics, and running a successful Kickstarter. Katherine's Kickstarter: Sprite Lights LED Body...

16 Okt 20251h 5min

511: Forty Trillion Divides

511: Forty Trillion Divides

Chris and Elecia talk about the show overflowing to another bit, fight over vim vs nano, consider awards, discuss writing (and self-motivation), consider linear algebra on AI cores, encourage remote d...

2 Okt 20251h 22min

510: The Secret Chip

510: The Secret Chip

Christina Cyr spoke with us about building cell phones, entrepreneurship, social purpose corporations, awards, lithium recycling, and her interesting career path. We talked about Christina's Cyrcle P...

19 Sep 20251h 4min

509: Swarmed by Engineers

509: Swarmed by Engineers

Steve Hinch wrote a book about engineering, innovation, and business. He shares decades of wisdom gleaned from his career at Hewlett-Packard and Agilent as an engineer, manager, marketing director, an...

5 Sep 20251h 13min

508: Descartes' Demon

508: Descartes' Demon

William Griffin spoke to us about hardware-in-the-loop testing, simulation, terminology, learning complex topics, and books. We don't usually expand upon the show title but Wikipedia has a rabbit hole...

21 Aug 20251h 22min

507: Turn Our Data Into Predators

507: Turn Our Data Into Predators

Chris and Elecia chat about books, courses, alternate podcasts, electronics, statistics, kidnapping Roo, and journaling failures. The Embedded Patreon book club is reading Data-Driven Science and Eng...

7 Aug 20251h 14min

506: How Do I Fit a Whale Into an Apartment Building?

506: How Do I Fit a Whale Into an Apartment Building?

Dmitry Grinberg joined us to talk about running Linux on small microprocessors (physically small and/or 4-bit). Dmitry does this by emulating a MIPS processor. Boot times vary between minutes and days...

25 Jul 20251h 2min

505: Potato in a Number Field

505: Potato in a Number Field

We spoke with Peter Griffin about Jumperless Breadboards, no-install GUI development, Excel, and puppies. Jumperless Breadboard at CrowdSupply Colab GUI for Jumperless Breadboard Website GUI for ...

10 Jul 20251h 18min

Populært innen Vitenskap

fastlegen
tingenes-tilstand
rekommandert
tomprat-med-gunnar-tjomlid
rss-rekommandert
forskningno
jss
sinnsyn
villmarksliv
smart-forklart
rss-paradigmepodden
fjellsportpodden
diagnose
tidlose-historier
nevropodden
aldring-og-helse-podden
dekodet-2
vett-og-vitenskap-med-gaute-einevoll
grunnstoffene
rss-nysgjerrige-norge