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

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

33: Quitting My Finnish Lessons

33: Quitting My Finnish Lessons

Alison Chaiken (Google+) and Elecia discuss what you need to know to get into development for the automotive market.  Check out Alison's she-devel site for a big list of links and resources or go to a...

2 Jan 201455min

32: Woo Woo Woo

32: Woo Woo Woo

Patrick Kane (@PSoC_Nation) is the director of the Cypress University Alliance, working with colleges to provide development kits and information to college (and high school) students. Happily, Patric...

24 Des 201341min

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 Des 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 Des 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 Des 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 Nov 201348min

Populært innen Vitenskap

fastlegen
tingenes-tilstand
jss
rekommandert
forskningno
sinnsyn
tomprat-med-gunnar-tjomlid
rss-nysgjerrige-norge
villmarksliv
rss-paradigmepodden
liberal-halvtime
nevropodden
fjellsportpodden
kvinnehelsepodden
rss-inn-til-kjernen-med-sunniva-rose
diagnose
smart-forklart
psykopoden
tidlose-historier
rss-rekommandert