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

Avsnitt(571)

19: Bacon and Beer Event

19: Bacon and Beer Event

Karen Field (@karenfield) and Elecia talk about 2014 DesignWest, the embedded systems conference, and how to submit your idea for a session. 2014  DesignWest is March 31 - April 3, 2014. Call for abst...

18 Sep 201346min

18: Brine Solids Building Up in Strange Places

18: Brine Solids Building Up in Strange Places

Elecia White and Amy Button discuss Amy's dream of going to Mars, her previous role in training astronauts to handle disasters, and her current work on a magic box of rocks that will keep Orion's air ...

11 Sep 201343min

17: Facebook Status: Maybe Not Dead

17: Facebook Status: Maybe Not Dead

Elecia White spoke with Elizabeth Brenner about devices that can be used to help families worry less about grandparents who live alone (and 87-year-old neighbor friends named Dolores).  Life Alert is ...

4 Sep 201353min

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 Aug 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 Aug 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 Aug 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 Aug 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 Juli 201349min

Populärt inom Vetenskap

dumma-manniskor
p3-dystopia
allt-du-velat-veta
svd-nyhetsartiklar
kapitalet-en-podd-om-ekonomi
rss-vetenskapsradion
det-morka-psyket
rss-spraket
rss-vetenskapsradion-2
medicinvetarna
rss-ufo-bortom-rimligt-tvivel-2
barnpsykologerna
dumforklarat
sexet
hacka-livet
paranormalt-med-caroline-giertz
vetenskapsradion
doden-hjarnan-kemisten
halsorevolutionen
vetenskap-och-halsa