Introduction and Goals

This document describes buenzlimarks, a bookmark management application. It is used to store and organise browser bookmarks and related things, such that they can be presented for fast and convenient access later.

The following goals have been established for this system:

• The system shall have all features of current competing products which are actually used by the target user base (family & friends of the developers).
• The system shall be highly available. Offline use is of equal priority to online use for UX considerations.
• Development of the system shall be an opportunity to gain experience with cutting edge technologies for the developers.

Requirements

Requirements are developed and documented as GitHub issues. They can be found here.

Quality Goals

The architecture of the system is designed to fulfill the following goals:

• Availability: The UX during offline use is of the highest possible quality.
• Efficiency: The self-hostable backend server is resource efficient to enable deployment on cheap hardware like a raspberry pi.
• Extensibility: The system is easily extensible to store information beyond simple website links as well as provide more UI customization capabilities.

Stakeholders

This is an overview of the stakeholders who

• should know the architecture
• have to be convinced of the architecture
• have to work with the architecture or with the code
• need the documentation of the architecture for their work
• have to come up with decisions about the system or its development