Add contracts for fragjan data formats and planned daw_document/v1 #16

New issue

Open

opened 2026-10-15 08:01:35 +02:00 by michael · 0 comments

michael commented

2026-10-15 08:01:35 +02:00

Owner

Goal

Every format exchanged between DAW programs, or written by people for
a DAW program, is described in this repository. Today several formats
exist only in fragjan code and README, so we keep searching where
something is specified.

Part 1: existing fragjan formats

Schemas used in DAW/fragjan without a contract here:

fragjan_pack/v1 -- rule and catalog pack
fragjan_rule/v1 -- single rule
fragjan_question/v1 -- catalog question
fragjan_answers/v1 -- answers of a mandate
fragjan_report/v1 -- report profile (DAW/fragjan#140, not released)
fragjan_result/v1 -- check result, consumed by adapters/ui
daw_log/v1 -- used by fragjan adapters/log; this repo has
daw_channel_log and daw_content_syslog, but no daw_log.
Clarify whether it is one of these or still missing.

Per TEMPLATE.md: form and exchange semantics only, no domain
vocabulary. Order by risk: formats written by people or other
programs first (answers, pack, question, report), internal ones later.

Part 2: planned daw_document/v1

Exchange format between a domain program (fragjan, steurjan, raidan,
sprengaz) and berhtjan for non-interactive documents: reports,
invoices, print and screen preview.

Concept: daw-modul-berhtjan-core docs/CONCEPT-DOCUMENT-COMPOSITION.md.
Settled so far:

the data set is already filtered by the domain program for one
audience and one context; the contract carries both
named sources as lists of records; domain results as finished fields
money values in a form suitable for exact decimal arithmetic

Design happens after the concept's open questions are settled; this
issue only reserves the place.

Acceptance criteria

Part 1: one directory per format, layout per TEMPLATE.md
Part 1: daw_log/v1 question answered
Part 2: separate issue opened once design starts

DAW/fragjan#140

## Goal Every format exchanged between DAW programs, or written by people for a DAW program, is described in this repository. Today several formats exist only in fragjan code and README, so we keep searching where something is specified. ## Part 1: existing fragjan formats Schemas used in DAW/fragjan without a contract here: - `fragjan_pack/v1` -- rule and catalog pack - `fragjan_rule/v1` -- single rule - `fragjan_question/v1` -- catalog question - `fragjan_answers/v1` -- answers of a mandate - `fragjan_report/v1` -- report profile (DAW/fragjan#140, not released) - `fragjan_result/v1` -- check result, consumed by adapters/ui - `daw_log/v1` -- used by fragjan adapters/log; this repo has `daw_channel_log` and `daw_content_syslog`, but no `daw_log`. Clarify whether it is one of these or still missing. Per TEMPLATE.md: form and exchange semantics only, no domain vocabulary. Order by risk: formats written by people or other programs first (answers, pack, question, report), internal ones later. ## Part 2: planned daw_document/v1 Exchange format between a domain program (fragjan, steurjan, raidan, sprengaz) and berhtjan for non-interactive documents: reports, invoices, print and screen preview. Concept: daw-modul-berhtjan-core `docs/CONCEPT-DOCUMENT-COMPOSITION.md`. Settled so far: - the data set is already filtered by the domain program for one audience and one context; the contract carries both - named sources as lists of records; domain results as finished fields - money values in a form suitable for exact decimal arithmetic Design happens after the concept's open questions are settled; this issue only reserves the place. ## Acceptance criteria - [ ] Part 1: one directory per format, layout per TEMPLATE.md - [ ] Part 1: `daw_log/v1` question answered - [ ] Part 2: separate issue opened once design starts ## Related DAW/fragjan#140

michael added the

labels

2026-10-15 08:01:35 +02:00

michael referenced this issue from DAW/daw-modul-berhtjan-core