Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update wording and fix formatting for checklist #494

Merged
merged 3 commits into from
Jul 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions _posts/2024-07-18-schematic-review-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ cheap.

Some pre-schematic review checklist items:

- [ ] Get invited to the schematic review. Really, this is a callout to be
- [x] Get invited to the schematic review. Really, this is a callout to be
working with your electrical engineer. If you've been working with your
electrical engineer, providing guidance on what hardware you'll need,
being invited to the schematic review should be a given.  - [ ] Build your
checklist upfront. Use this blog post as a starting point, but make sure you
customize the list for the given project.
being invited to the schematic review should be a given.
- [x] Build your checklist upfront. Use this blog post as a starting point, but
make sure you customize the list for the given project.

## Story 1 - Brown-out Loop {#story-1-brown-out-loop}

Expand Down Expand Up @@ -103,7 +103,7 @@ voltage of < CUTOFF VOLTAGE and the device did not detect a second power source
(measured by a GPIO being pulled high), the device would sit in a
`while (!external_power_okay()) {pet_watchdog();}` style loop, keeping at least
external flash ok. We also upgraded our external flash filesystem to a version
that was much more relisiant to boot loops.
that was much more resilient to boot loops.

After this story, I always look to see if a battery powered device can both: (1)
effectively monitor battery state of charge, and (2) shutdown in a low state of
Expand Down Expand Up @@ -188,8 +188,7 @@ to be able to fix those issues, not just the ones you can see at your desk.

## My current checklist

Here's my current checklist. I didn't list all the stories as above (this
would've made way too long of a checklist), but I hope it's helpful for others!
Given these experiences, I have compiled the following list:

### Power/Battery

Expand Down Expand Up @@ -247,12 +246,13 @@ would've made way too long of a checklist), but I hope it's helpful for others!

## Conclusion

This is the start of my checklist for schematic reviews. Feel free to take
it/modify, and add to it. Or, even better, comment on this article with your own
horror stories and lessons learned! I've found it useful to keep stories with
rules to help me remember why the rules exist in the first place. All rules are
meant to be broken, and sometimes I end up waiving items from the checklist, or
adding new items for specific projects. These rules have helped me catch a few
This checklist captures the most important items I have learned to ask about as
a firmware developer in schematic reviews. Feel free to take it/modify, and add
to it. Or, even better, comment on this article with your own horror stories and
lessons learned! I've found it useful to keep stories with rules to help me
remember why the rules exist in the first place. All rules are meant to be
broken, and sometimes I end up waiving items from the checklist, or adding new
items for specific projects. These rules have helped me catch a few
hardware/software interactions before boards were produced, which helped us keep
to our schedule and get devices shipped on time!

Expand Down
Loading