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

31: If You See a Dongle Run Away

31: If You See a Dongle Run Away

Producer Christopher (@stoneymonster) joins Elecia to look through their mailbag and talk about gift ideas. Podcasts we like: The Amp Hour 99% Invisible Radiolab 5x5 network's Back to Work Accidenta...

19 Joulu 20131h 15min

30: Eventually Lightning Strikes

30: Eventually Lightning Strikes

James Grenning (@jwgrenning) joined Elecia to talk about how to be a good programmer using Test Driven Development (TDD). James' excellent book on how to use TDD: Test Driven Development for Embedded ...

11 Joulu 201356min

29: Ducking the Quadcopter

29: Ducking the Quadcopter

Kathleen Vaeth of MicroGen Systems (@MicroGenSystems) spoke with Elecia (@LogicalElegance) about energy harvesting using MEMS devices. Some introductory videos: BOLT™ Micro Power Generator An energy ...

4 Joulu 201345min

28: A Lot of Wish Fulfillment

28: A Lot of Wish Fulfillment

Author Laura Lemay (@lemay) spoke with Elecia (@logicalelegance) about writing books, APIs, code, and science fiction.  Laura wrote many of the Teach Yourself ... in 21 Days books: her bibliography on...

20 Marras 201348min

27: You Are Blowing My Mind

27: You Are Blowing My Mind

From the MEMS Industry Group Executive Congress: Ivo Stivoric, co-founder of the Body Media which was purchased by Jawbone CEO Sam Guilaume and Dave Rothenberg of Movea Stephen Walsh, ISKN – iSketch...

13 Marras 20130s

26: The Tofu Problem

26: The Tofu Problem

In this in-depth technical discussion, Dr. Ken Lunde helps Elecia understand how to internationalize her (memory constrained) device. CJVK Information Processing, Ken's excellent O'Reilly book on inte...

7 Marras 20131h

25: Thunderdome for Antennas

25: Thunderdome for Antennas

Jen Costillo surfaced briefly from her startup-induced blackout to share her wisdom about manufacturing consumer products. They discussed new product development and working from (and making modificat...

30 Loka 201351min

24: I'm a Total Fraud

24: I'm a Total Fraud

Listener Jim Gf posed an interesting question about how to tell if you are a good embedded software engineer. Producer Christopher White joins Elecia to fail to give an answer. While they mention the ...

23 Loka 201353min

Suosittua kategoriassa Tiede

tiedekulma-podcast
rss-mita-tulisi-tietaa
rss-poliisin-mieli
docemilia
radio-antro
utelias-mieli
filocast-filosofian-perusteet
rss-sosiopodi
ihanat-ipanat
mielipaivakirja
rss-bios-podcast
rss-duodecim-lehti
rss-ammamafia
rss-laakaripodi
rss-opeklubi