Skip to content

Document whether/how to include decision/transfer docs in the repo #460

Open

Description

@samglover

Perhaps a decisions, transfer, or handoff folder? Or if they should be private, perhaps simply including a link to a project folder in the LIT Lab's OneDrive?

Activity

  1. samglover commented on Oct 1, 2024

    @samglover
    ContributorAuthor

    This will have to be a generalized guide. For LIT Lab projects, each project has its own channel in the LIT Clinic Teams team for discussions, files, etc. Perhaps include how other interview building teams do it?

  2. samglover commented on Feb 10, 2025

    @samglover
    ContributorAuthor

    On reflection I think the primary place to document transfer information should be the README. If there needs to be more extensive documentation, information about where to find it should be included in the README.

  3. samglover commented on Apr 16, 2025

    @samglover
    ContributorAuthor

    From #472:

    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestintermediateGood issue for intermediate DAL developers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions