Here are the first three chapters of my arc42-based architecture documentation. Next time we are doing the architecture constrains and maybe the system scope. It is necessary if I want to make it right, but if you are bored, please wait for 2–3 posts, when we will start describing the system structure 🙂
Introduction and Goals
This project is an effort of establishing a development workflow via practical product development.
There are two main requirements for the project:
- The product should be a working and entertaining for a cat autonomous toy.
- Components, processes and libraries of the project must be developed to be reusable in other projects.
The project is based on the following principles:
- Architecture-oriented
- Develop the right architecture using architectural best practices
- Result-oriented and minimalistic
- Progress over perfection
- Integration-oriented
- Reusing existing libraries, projects, etc. Minimum development of individual pieces
- Reusable in my other projects
- It should be done automatically with a good architecture. But I want to make several special decisions to make the project easy to transfer to my another robotic project.
Quality Goals
N | Quality | Motivation |
1 | Cat Friendliness | The product should be interesting and attractive for a cat |
2 | Safety | The product should be safe for pets, it should not harm the pet in any way |
3 | Development Reusability | The project components should be easy to reuse in other projects. Especially in my own projects |
Stakeholders
Role/Name | Expectations |
Cats (especially Bastet) | Cats should get a simple, funny toy that is able to entertain them. |
Developers | Developers must get a polished, transparent quality product that can be reused or valuable from the education point of view |
Andrei Gramakov | I suppose to do two things at once: 1. improve my architect skills, 2. move my another enormously big robotic project. |
Potential employers of Andrei Gramakov | Should get an illustrative entry in my portfolio to better understand my skills and experience. |
Discussions
Become a Hackaday.io Member
Create an account to leave a comment. Already have an account? Log In.