docassemble-ALWeaver icon indicating copy to clipboard operation
docassemble-ALWeaver copied to clipboard

Consider letting developer generate an umbrella interview file

Open nonprofittechy opened this issue 4 years ago • 3 comments

An "umbrella" file is one that is designed to be included into another interview. See: https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/coding_style_guide/yaml#use-clear-filenames-for-modular-interview-files

We could add a feature to the Weaver that instead of creating one YAML file that has a mandatory block, creates multiple files, one with a mandatory block and another that just has the questions and attachment block that you might want if you were going to include the interview into another interview.

For a real world example: both a standalone version of a 93A demand letter, and one that you embed inside an interview focused on housing conditions.

This is a powerful feature of Docassemble but fairly niche task to use the Weaver for. It does take about 30 minutes of mechanical work to separate a single YAML file into the two files you need for an umbrella so it's possible the Weaver could help with this task.

nonprofittechy avatar Feb 01 '21 17:02 nonprofittechy

We can always revisit this but closing for now--it's a very specific instance of something that #484 mostly addresses. It's a pretty advanced modularity task and it's not clear the Weaver will help people achieve it in a simple way.

nonprofittechy avatar Jul 07 '22 17:07 nonprofittechy

Disagree that it's solved by #484, that's just a workaround, and still requires you to re-do the interview logic for each new interview that you're using the form in.

I also don't feel like this is a niche thing, as every jurisdiction has some fee waiver form, probably an interpreter notice, and something I've been seeing a lot recently, a certificate of service.

It does take about 30 minutes of mechanical work to separate a single YAML file into the two files you need for an umbrella

The key part to me is that it's 30 minutes of mechanical bug-prone work; people (include myself) are likely to miss small things that might work fine in a single interview, but will break when you start embedding it in other interviews. Getting right is important, but also hard to do (as with a lot of more advanced docassemble things).

I'm willing to take a shot at this when I'm wrapped up with e-filing, probably at the same time as I consider how to output a "closer-to-ready" efileable interview.

BryceStevenWilley avatar Jul 09 '22 18:07 BryceStevenWilley

Definitely open to you giving this a try. I think first we should address #349 and have it integrated with the configuration system, otherwise I worry it will be relatively fragile to code around.

nonprofittechy avatar Jul 09 '22 18:07 nonprofittechy