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(569)

41: Pink Universes Die Really Quickly

41: Pink Universes Die Really Quickly

Micah Elizabeth Scott (@scanlime) came to talk about Fadecandy, a really neat way to control smart LEDs (NeoPixel, AdaFruit's term for the WS2812). The conversation ranged from beautiful LED control a...

5 Mar 201456min

40: Mwahaha Session

40: Mwahaha Session

Evil Mad Scientist's Lenore Edman (@EMSL) talks about what evil mad scientists do on their path to world domination. Surprisingly, it consists largely of art, education, and soldering. Some EMSL items...

26 Feb 201456min

39: I Blame Space

39: I Blame Space

Jen Costillo (@r0b0ts0nf1r3) joined Elecia to talk about Jen's start-up: Bia Sport (@BiaSport). They discuss the difficulties of being in an underfunded start-up as well as the joys of shipping a new ...

19 Feb 20141h

38: Blame the Monkey

38: Blame the Monkey

Producer Chris White (@stoneymonster) and Elecia discuss some insurmountable problems and some strategies for approaching them.  Google it (or look on Stack Exchange). Explain the problem to someone ...

12 Feb 20141h 1min

37: Surf's Up

37: Surf's Up

Dr. Karen Shell and Elecia talk about modelling vs. building models, ocean albedo vs. ice, climate vs. weather, and science vs. policy. They gloat about being on vacation only intermittently. National...

31 Jan 201450min

36: Drive the Boat with a Wii Mote

36: Drive the Boat with a Wii Mote

Elecia gushes about her favorite logic (and protocol) analyzer to Saleae co-founder Mark Garrison. They also discuss start-ups, manufacturing, and covering yourself with rum and pretending to be a pir...

22 Jan 201452min

35: All These Different Reasons Why You Might Want to Do Something

35: All These Different Reasons Why You Might Want to Do Something

Want to learn how to get from idea to schematic, through layout, all the way to physical boards? Elecia spoke with Chris Gammell about his Contextual Electronics course to teach the missing steps betw...

15 Jan 201456min

34: Really Big Cabbage

34: Really Big Cabbage

Elecia describes to Christopher (@stoneymonster) how to design and create a firmware update mechanism. Hilarity ensues.  4k PC emulator Making Embedded Systems, the book, on O'Reilly (coupon in last 2...

9 Jan 20140s

Populært innen Vitenskap

fastlegen
rekommandert
tingenes-tilstand
jss
rss-rekommandert
sinnsyn
forskningno
liberal-halvtime
fjellsportpodden
rss-nysgjerrige-norge
kvinnehelsepodden
nordnorsk-historie
villmarksliv
vett-og-vitenskap-med-gaute-einevoll
hva-er-greia-med
smart-forklart
nevropodden
tidlose-historier
aldring-og-helse-podden
rss-radium