This page and it’s subpages defined the features we support out of the box in Baseplate. Each is laid out in a standard fashion:
- Description – A description of the feature including what business problem the user has that it solves, how the user expects to interact with the feature and any examples of similar features a developer can look at for inspiration.
- Role Access – For each role listed in the system (both system standard and rich roles) details for each of the following
- Overview – a one to two paragraph overview of what aspects of this feature the given user would need access to.
- User Stories – Up to thirty user stories relating to feature use from the perspective of the end user in the relevant role. This should articulate what the user is trying to accomplish and how and what business problem they are trying to address through the user story. If relevant, add any details about how the end user would interact with the feature.
- Pages and Screens – A list of pages or screens that will need to be implemented as part of the implementation of the feature:
- Description – A prose description of what the screen does including what it does in relation to other screens in the functional workflow
- Screen Content – A list of the content to be provided on the screen including anything needed such as static text, illustrative images and data display or entry fields. For any data display or entry fields list
- Name – The label of the field to be displayed on the screen
- Constraints – Any constraints for the field (required, length, format, etc.)
- Error Checking – Error checks to be applied on the field on submission including error messages to be displayed if an error state is detected
- Field Notes – Any other notes of the implementation of the field.
- Figma Link – If a Figma file exists for this screen a link to it
- Query and Setup – Any data queries needed to populate the screen and any business logic that needs to be executed to setup the screen
- Actions – If the screen allows the user to take actions what happens when each is executed
- Notes – Any other notes on the screen relevant for implementation or understanding it’s use
- Data Model – A description of the data fields needed to implement this feature and a table formatted list of all data fields needed to implement this feature. Typically formatted as a table with the following columns
- Name – Name of the field
- Description – A description of the field
- Constraints – Any constraints associated with the field such as presence / required, length, formatting or options if a select list
- Notes – Any additional notes for the field
- LLM Query – Any notes on LLM queries that will be used to aid in generating the data or content associated with this feature