Planning OFT's native document exchange format for exports and reports and deprecating the SpecObject format #581
redcatbear
announced in
Announcements
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
The SpecObject format was inherited from ReqM2 and shows some signs of age. It's not quite internally consistent. XML as basis seems dated and it was never really adapted to OFT.
That's why for OFT 5 which we plan to release late in 2027, we want to remove the SpecObject format.
Instead, OFT 4 will get two JSON-based formats:
.oftx.json: For exports / exchange.oftr.json: For reportsOFTR is OFTX plus tracing information and a summary.
Checkout PR #580 for a work-in-progress draft of the JSON schema and two examples.
Delimitation: we do not plan to make that a full document format (yet). If projects want document exchange, simply reference the original Markdown / RST. No need to invent something new. This is intended as a machine-to-machine format which should still be human-readable for debugging. And of course, it will help with agentic usecases.
Your feedback is welcome!
All reactions