Skip to content

Commit a53fe6c

Browse files
Merge pull request #546 from SuffolkLITLab/copilot/fix-148
Add comprehensive interview flow planning guidance with tools and methodologies
2 parents fed21ee + 72a48e8 commit a53fe6c

File tree

3 files changed

+112
-6
lines changed

3 files changed

+112
-6
lines changed

docs/get_started/beginners_guide.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,13 @@ The Weaver is a Document Assembly Line tool that generates a draft Docassemble i
4141

4242
The interview generated by the Weaver is not a finished interview. It is a starting point intended for further editing.
4343

44-
Now you are probably itching to start building your first interview! But before you do, take a moment to review the interview-building workflow and join the Document Assembly Line community.
44+
Now you are probably itching to start building your first interview! But before you do, take a moment to plan your interview flow and review the interview-building workflow.
45+
46+
## Plan your interview flow first
47+
48+
Before you start building, take time to plan your interview's structure and flow. This upfront planning can save you hours of rework later.
49+
50+
**➡️ [Plan your interview flow and structure.](plan_interview.md)**
4551

4652
## Review the interview project management guide
4753

docs/get_started/plan_interview.md

Lines changed: 104 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,111 @@ Reasons to avoid DOCX files:
5959
* DOCX files can be formatted, but content may flow unexpectedly if it is longer
6060
than expected
6161

62-
## Do some advance work to draft questions and a question order
62+
## Plan your interview flow and structure before you build
6363

64-
The automation process will go better if you have planned out a basic
65-
structure for your interview, as well as thought through the information
66-
that you need to gather. Focus on a rough sketch of the process that your
67-
form enables as well as the questions that you will ask to fill it in.
64+
:::tip
65+
Taking time to plan your interview flow before building can save you hours of rework later. A clear plan helps you identify complex branching logic early and ensures a smooth user experience.
66+
:::
67+
68+
The automation process will go much better if you have planned out the basic structure for your interview, as well as thought through the information that you need to gather. Focus on creating a rough sketch of the process that your form enables as well as the questions that you will ask to fill it in.
69+
70+
### Why plan first?
71+
72+
Planning your interview flow before diving into coding helps you:
73+
74+
- **Identify complex logic early**: Spot conditional sections, branching paths, and dependencies before they become problems
75+
- **Create a logical question order**: Ensure users aren't asked to provide information they don't have yet
76+
- **Avoid major rework**: Changes to flow are much easier to make in planning than after coding
77+
- **Ensure completeness**: Make sure you gather all required information without redundancy
78+
- **Design for user experience**: Think through the user's journey and mental model
79+
80+
### Tools for planning your interview flow
81+
82+
You have many options for mapping out your interview, from simple to sophisticated:
83+
84+
#### Paper and pencil
85+
- **Best for**: Quick brainstorming and initial sketches
86+
- **Pros**: Fast, flexible, no learning curve
87+
- **Cons**: Hard to share and iterate with teams
88+
89+
#### Digital flowchart tools
90+
- **[draw.io](https://draw.io)** (now Diagrams.net): Free, web-based, integrates with Google Drive/GitHub
91+
- **[Lucidchart](https://www.lucidchart.com/)**: Professional diagramming with collaboration features
92+
- **[Miro](https://miro.com/)** or **[Mural](https://www.mural.co/)**: Digital whiteboarding for collaborative planning
93+
- **[Whimsical](https://whimsical.com/)**: Simple, clean interface for flowcharts and wireframes
94+
95+
#### Specialized planning methods
96+
- **User journey mapping**: Map the user's path from start to finish, including their goals and pain points
97+
- **Story mapping**: Break down the interview into user stories and organize them by priority
98+
- **Paper prototyping**: Create mockups of key screens to test the flow with real users
99+
100+
### What to include in your interview plan
101+
102+
Your planning should cover these key elements:
103+
104+
#### 1. User journey and entry points
105+
- How do users find your interview?
106+
- What brings them to this point?
107+
- What's their mental state and level of legal knowledge?
108+
109+
#### 2. Information gathering sequence
110+
- What information do you need to collect?
111+
- What order makes sense to the user?
112+
- Which questions depend on previous answers?
113+
114+
#### 3. Conditional logic and branching
115+
- When should users skip certain sections?
116+
- What different paths might users take?
117+
- How do different user types experience the interview?
118+
119+
#### 4. Review and completion
120+
- How will users review their answers?
121+
- What documents will be generated?
122+
- What happens after completion?
123+
124+
### Sample planning workflow
125+
126+
1. **Start with the end**: What documents need to be produced? What information is required?
127+
128+
2. **Map the user journey**: Walk through the user's perspective from start to finish
129+
130+
3. **Create a rough flowchart**: Use any of the tools mentioned above to sketch the basic flow
131+
132+
4. **Identify decision points**: Mark where the interview branches based on user input
133+
134+
5. **Group related questions**: Organize questions into logical sections or pages
135+
136+
6. **Plan the review screen**: Decide how users will review and edit their answers
137+
138+
7. **Test with stakeholders**: Share your plan with colleagues or potential users for feedback
139+
140+
### Example: Planning a simple motion interview
141+
142+
Here's how you might plan a basic court motion interview:
143+
144+
```
145+
Start → Court information → User type (attorney/self-rep)
146+
147+
Party information → Case details → Motion type
148+
149+
Motion-specific questions → Supporting facts → Relief requested
150+
151+
Review screen → Document generation → Next steps/filing information
152+
```
153+
154+
Even this simple flow reveals important questions:
155+
- Should court information come first, or party information?
156+
- How does the user type affect what questions we ask?
157+
- What motion-specific questions are needed for each type?
158+
159+
### Integration with project management
160+
161+
Your interview planning should connect with your broader [project management approach](project_management.md). Share your flowcharts and planning documents with your team, and use them to:
162+
163+
- Estimate development time more accurately
164+
- Identify potential technical challenges early
165+
- Create test cases for different user paths
166+
- Brief developers on the intended user experience
68167

69168
## Preparing your template for automation
70169

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ module.exports = {
55
'get_started/intro',
66
'get_started/al_project_architecture',
77
'get_started/installation',
8+
'get_started/plan_interview',
89
'get_started/beginners_guide',
910
{
1011
label: 'Interview projects',

0 commit comments

Comments
 (0)