288: You Got a Screen!
Embedded10 Touko 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).

Jaksot(568)

16: Democracy Is the Worst Form of Government

16: Democracy Is the Worst Form of Government

Elecia tries to get a handle on whether Agile works with embedded software.  Curtis Cole (@citizencurtis) argues in favor of user stories, scrums, and story points. Agile software development on Wikip...

28 Elo 201353min

15: Robot on the Front

15: Robot on the Front

Andreas Eieland (@AndreasMCUguy) from Atmel joined Elecia to talk about how the AVR processor line came to life, why there is an AVR in Arduino, and the spirit of making things. Arduino AVR Freaks Atm...

21 Elo 201348min

14: Hot

14: Hot

Artist Kristin Anderson of Idle Creativity spoke with Elecia about the technology of working with slumped glass, getting started on Etsy (Elecia mentioned her craft electronic ideas), and moving from ...

15 Elo 201341min

13: Introspective Nasal Gazing

13: Introspective Nasal Gazing

Christopher White ( @stoneymonster) emerges from his producer responsibilities to chat with Elecia about starting a podcast: the gadgetry, the software, the distribution, and, the big question, why we...

7 Elo 201354min

12: You Have a Jedi Sword

12: You Have a Jedi Sword

Dr. Edward White spoke with Elecia about how technology has changed medicine. He described gadgets used in surgery (harmonic scalpel!), how hospitals acquire tools, and why engineers should be focused...

31 Heinä 201349min

11: Tell Me I'm Wrong, It's Fine

11: Tell Me I'm Wrong, It's Fine

Karen Lightman (‏@khlightman) joins Elecia White to talk about the infinite awesomeness of tiny MEMS devices. Recorded at the (somewhat noisy but lovely and delicious) Blue Brasserie during SEMICON We...

25 Heinä 20131h 1min

10: Hands Off, Baby

10: Hands Off, Baby

Jen Costillo (@r0b0ts0nf1r3) joins Elecia White to discuss the secret parts of C, keywords that only embedded software engineers seem to know about. They talk about interviewing and why these keywords...

17 Heinä 201358min

9: Kidnapped and Blindfolded

9: Kidnapped and Blindfolded

Randi Eckstein grilled Elecia White (@logicalelegance) on inertial sensors: when to use accelerometers vs. gyroscopes; gyroscopes vs. rate sensors; how to make an inertial measurement unit; the basics...

9 Heinä 20131h 3min

Suosittua kategoriassa Tiede

rss-poliisin-mieli
tiedekulma-podcast
rss-mita-tulisi-tietaa
docemilia
rss-luontopodi-samuel-glassar-tutkii-luonnon-ihmeita
rss-duodecim-lehti
utelias-mieli
radio-antro
rss-astetta-parempi-elama-podcast
rss-lapsuuden-rakentajat-podcast
rss-lihavuudesta-podcast
rss-sosiopodi