The structure of the documenation for the SMART SPOT Backpack is inspired by a post from Simon Brown:
[...] I propose something akin to a travel guidebook. Imagine you arrive in a new city. Without any maps or a sense of direction, you'll end up just walking up and down every street trying to find something you recognise or something of interest. You can certainly have conversations with the people who you meet, but that will get tiring really quickly. If I was a new joiner on an existing software development team, what I'd personally like is something that I can sit down and read over a coffee, perhaps for an hour or so, that will give me a really good starting point to jump into and start exploring the code.
So enjoy your coffee and read about the design of the SMART SPOT backpack.
Note some sections of Simon Brown's guide have been removed or adjusted in order to make it fit to a hardware project:
- Removed sections:
- Data
- Infrastructure Architecture
- Software Architecture -> integrated in Functional Overview (with a system diagram of the hardware architecture)
- Renamed sections:
- Code -> Implementation
- Deployment -> Instructions
- Operations & Support -> Support & Contributions
In the next section you read about the context of the SMART SPOT Backpack, i.e. why and for who the backpack was developed.