Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document a method for including transfer docs in an interview repo #472

Open
samglover opened this issue Oct 8, 2024 · 0 comments
Open

Comments

@samglover
Copy link
Contributor

samglover commented Oct 8, 2024

For more complex interviews, it can be useful to start with a flowchart that can be approved by stakeholders. Then the interview can be tested against the flowchart.

Perhaps more critically, some jurisdictions have complex e-filing logic. Documenting this logic as a Mermaid flowchart in the repo would make it possible for the court or org to request changes like any other pull request, and give the developer(s) clear guidance for implementing those changes in the code.

I think we should probably add a docs folder in interview repos when they contain flowcharts or other documentation (such as transfer memos).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant