Add comprehensive documentation for key organizational aspects
All checks were successful
On Push to Main / test (push) Successful in 1m33s
On Push to Main / publish (push) Successful in 1m31s
On Push to Main / deploy-dev (push) Successful in 2m3s

- Introduced "Pension Scheme & Benefits" detailing secondary employment benefits and pension specifics.
- Created "Roles & Accountabilities" outlining the Holacracy role structure and responsibilities within Respellion.
- Added "Security" section covering GDPR compliance and workplace safety protocols.
- Established "Spending and Contracting" policy detailing expense categories and submission processes.
- Documented "Who We Are" to define Respellion's identity, services, and operational model under Holacracy and ISO 9001.
This commit is contained in:
RaymondVerhoef
2026-05-27 08:24:56 +02:00
parent 7066f881f9
commit 07af2783dc
26 changed files with 2631 additions and 4598 deletions

View File

@@ -8,8 +8,13 @@ perspective — interaction patterns, completion rules, and the relationship
between micro learnings, topics, and sessions.
This document is application-agnostic. It does not describe how micro
learnings are generated, stored, or administered. For those topics see the
micro learning generation specification.
learnings are generated, stored, or administered. For those topics see
`docs/generation-spec.md`.
> **Current types:** the platform ships **three** micro-learning types —
> `concept_explainer`, `scenario_quiz`, and `flashcard_set`. A fourth
> (`reflection_prompt`) was specced earlier and has since been dropped.
> References to it below are retained only as historical context.
---
@@ -47,17 +52,15 @@ Theme (one per weekly session)
└── Topic A
│ ├── Concept explainer ← micro learning
│ ├── Scenario quiz ← micro learning
── Flashcard set ← micro learning
│ └── Reflection prompt ← micro learning
── Flashcard set ← micro learning
└── Topic B
├── Concept explainer
├── Scenario quiz
── Flashcard set
└── Reflection prompt
── Flashcard set
```
One session covers one Theme. A Theme contains multiple Topics. Each Topic
has up to four micro learnings — one per type. The employee selects which
has up to three micro learnings — one per type. The employee selects which
type to engage with per Topic per session.
---
@@ -97,7 +100,6 @@ Each type has its own completion trigger:
| Concept explainer | Employee reaches the end of the content |
| Scenario quiz | Employee selects an answer and views the explanation |
| Flashcard set | Employee views all cards in the set at least once |
| Reflection prompt | Employee submits a response (any response) |
Completion is not quality-gated. The employee does not need to answer
correctly or respond thoughtfully. The act of engaging with the full micro
@@ -128,7 +130,11 @@ per session.
---
## The four types — learner perspective
## The micro-learning types — learner perspective
> Three types are active: **Concept explainer**, **Scenario quiz**, and
> **Flashcard set**. The **Reflection prompt** subsection below is retained for
> historical context only — that type is not currently generated or shown.
### Concept explainer
@@ -296,28 +302,33 @@ a completion and contributes to the employee's history.
These are logical entities described from the learner's perspective.
Implementation may map them to any storage system.
**MicroLearning** (the artifact)
These map to the `micro_learnings` and `micro_learning_completions` PocketBase
collections (see `docs/data-model.md`).
**MicroLearning** (the artifact — `micro_learnings`)
```
id
topic → Topic
type concept_explainer | scenario_quiz |
flashcard_set | reflection_prompt
content structured data per type schema
topic_id → Topic
type concept_explainer | scenario_quiz | flashcard_set
content structured data per type schema (JSON)
status published (only published items are visible to employees)
```
**MicroLearningCompletion** (the event)
**MicroLearningCompletion** (the event`micro_learning_completions`)
```
id
employee → Employee
micro_learning → MicroLearning
topic → Topic
team_member_id → team member (employee)
micro_learning_id → MicroLearning
topic_id → Topic
type type identifier at time of completion
completed_at datetime
session_week integer — curriculum week when completed
cycle integer — which cycle
session_week integer — the user's absolute curriculum week when completed
created datetime (PocketBase autodate)
```
`session_week` is the per-user absolute week counter (week 1 begins the day the
employee enrolls). The 26-week slot and cycle are derived from it; there is no
separate stored `cycle` field.
Completions are append-only. They are never updated or deleted. Each
represents a discrete learning event in the employee's history.
@@ -346,14 +357,12 @@ represents a discrete learning event in the employee's history.
3. An employee who selects an incorrect answer in a scenario quiz sees
explanations for all options, not only their chosen option
4. An employee cannot complete a flashcard set without viewing all cards
5. An employee who submits any text in a reflection prompt completes the
micro learning — the content of the response is not evaluated
6. Completing one type for a Topic does not remove or replace the
5. Completing one type for a Topic does not remove or replace the
completion record for another type for the same Topic
7. A Topic with one completed type counts as engaged for session progress
8. An employee can access and complete micro learnings from the knowledge
6. A Topic with one completed type counts as engaged for session progress
7. An employee can access and complete micro learnings from the knowledge
library outside of their scheduled session week
9. Each completion creates exactly one record — submitting a reflection
prompt twice creates two records, not one updated record
10. An employee in cycle 2 can complete a flashcard set for a Topic they
completed in cycle 1 — the new completion is recorded independently
8. Each completion creates exactly one record — completing the same type
twice creates two records, not one updated record
9. An employee in cycle 2 can complete a flashcard set for a Topic they
completed in cycle 1 — the new completion is recorded independently