Schema generation capability outline #46

Closed
opened 2025-09-30 21:54:44 +00:00 by tegwick · 0 comments
Owner

I want schemas to have the capability and capture the outline of the file they have been generated from.

From a users pespective this could be achieved by something like "markitect schema-generate --mode outline --depth 3 --outfile invoice.json example.md"

In the title of the schema it should read "Schema from example.md" not "Schema for example.md" because that is what happens.

For the headings the actual heading-text should be captured in the schema and I would like to have the option to also provide an instruction about what should go into the content fields below those headings.

The usecase I am aiming for is:

  • pick a good example for something I need variations of, maybe a structured requirements document
  • generate a schema from the example
  • tune the schema file drop what is too specific and keep the essential stuff
  • part of the outline will be there to keep with it's specific headlines
  • add insstructions to the remaining content slots
  • generate drafts from the schema
  • later provide a dialog to prime the draft with data
  • later provide a datasource to generate multiple drafts from the data based on the schema

As the drafts will retain a reference to their master schema

  • changes later on can be verified against the schema
  • it will be useful to enable to improve schemas with additional rules or expectations for the content file derived from it

When we start working on this issue the first thing to do is, create additional issues from this intended workflow.

The first one might be to define a metaschema for the jason schema structure that we need as a foundation to do stuff like this.

I want schemas to have the capability and capture the outline of the file they have been generated from. From a users pespective this could be achieved by something like "markitect schema-generate --mode outline --depth 3 --outfile invoice.json example.md" In the title of the schema it should read "Schema from example.md" not "Schema for example.md" because that is what happens. For the headings the actual heading-text should be captured in the schema and I would like to have the option to also provide an instruction about what should go into the content fields below those headings. The usecase I am aiming for is: - pick a good example for something I need variations of, maybe a structured requirements document - generate a schema from the example - tune the schema file drop what is too specific and keep the essential stuff - part of the outline will be there to keep with it's specific headlines - add insstructions to the remaining content slots - generate drafts from the schema - later provide a dialog to prime the draft with data - later provide a datasource to generate multiple drafts from the data based on the schema As the drafts will retain a reference to their master schema - changes later on can be verified against the schema - it will be useful to enable to improve schemas with additional rules or expectations for the content file derived from it When we start working on this issue the first thing to do is, create additional issues from this intended workflow. The first one might be to define a metaschema for the jason schema structure that we need as a foundation to do stuff like this.
tegwick added this to the Schemata, Templates and Relationships project 2025-09-30 21:54:44 +00:00
Sign in to join this conversation.