Introduction and Goals
We are building the new Search for Statista here. The current search is called globalsearch, so we called this iteration universalsearch 🤯.
None of this is live yet.
About arc42
We are using arc42 as documentation framework. Not because it is the best framework but because having A framework is better than chaotic documentation. Most notably, having guidance on where to put your documentation reduced mental load and friction. Check this arc42 overview to get a short description of each section. In the spirit of keeping things lean we don't have each section but don't adjust the numbering. Hence, 05 is always the Building Block View.
Our documentation principles
- Keep your documentation high-level. We don't want to update every time we do some minor architecture or code changes. Also, most stakeholders want to get a high-level overview. For details, read the code and code comments.