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).

Det här avsnittet är hämtat från ett öppet RSS-flöde och publiceras inte av Podme. Det kan innehålla reklam.

Avsnitt(572)

525: Some Sort of Metal

Dr. Tom Williams spoke with us about robots, ethics, teaching, and books. Then we talked about mines, umpires, water, and more books. Tom is the author of Degrees of Freedom: On Robotics and Social J...

14 Maj 1h 3min

524: This Isn't a Movie

Nathan Jones spoke with us about hardware security, motivation, conference talks, and writing. Nathan wrote an in-depth series of posts about the benefits of superloops vs RTOS: You Don't Need an RTOS...

16 Apr 1h 14min

523: Bad Experience With Donuts

Chris and Elecia chat about Leapfrog toys, things they like, large company politics, awards, and open source governance. The Toy Story 5 Trailer with LilyPad toy which is suspiciously similar to the ...

2 Apr 1h 10min

522: The Information Is In Poop

Sonia Grego speaks with us about a topic no one likes to talk about, but could be used to monitor personal dietary health and widespread disease outbreaks. Toilets! Sonia leads Duke University's Smart...

6 Mars 54min

521: Are You The Tiny Domino?

Kenneth Finnegan entertained us with stories about accidentally contributing to the internet's ability to network. Wondering how the internet works? All those terms about IPv4, IPv6, BGP, OSPF, CDN an...

20 Feb 1h 3min

520: All Sorts of Interesting Facts About Teeth

Chris and Elecia apologize, discuss uses and abuses of chatbots, reach out to an uncertain manager, try to help someone out of their professor's draconian rules, and extol the joys of reading. Chabot...

6 Feb 58min

519: The Password Is All Zeros

Mark Omo and James Rowley spoke with us about safecracking, security, and the ethics of doing a bad job. Mark and James gave an excellent talk on the development of their safecracking tools at DEF CON...

23 Jan 1h 6min

518: Nothing We Can Do About Frogs

James Cameron spoke with us about programming for and operating a large telescope. The show is a blend of astronomy, engineering on the fly, and weird lady bug habitats. The Anglo-Australian Telescop...

9 Jan 1h 8min