Skip to content

Commit

Permalink
Refine wording
Browse files Browse the repository at this point in the history
  • Loading branch information
basham committed Oct 24, 2023
1 parent 88c82f5 commit 6971e03
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions src/content/writings/2023-10-23-organizing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A project log documents notable things about a project, organized chronologicall

Capturing these details makes it easier to remember the journey of your team and reflect on the challenges along the way. It can be a reference for reports and discussions with stakeholders. For example (links are represented with underlined text):

- **May 9, 2023:** Nora and Raj introduce the project (see <u>ST-2725</u>) to Katia.
- **May 9, 2023:** Nora and Raj introduce the project (see <u>#2725</u>) to Katia.
- **May 11, 2023:** Katia and Raj draft <u>research plan</u>.
- **May 17, 2023:** Katia and Raj refine research plan. Katia shares <u>Figma mockups</u>.
- **May 22 to May 31, 2023:** Katia and Raj conduct user research interviews with eight participants.
Expand All @@ -35,9 +35,9 @@ User research sessions can produce many files: the session recording and transcr
- the date and time of the session
- the name of the participant

To guarantee folders are sorted chronologically, the first part of the name should be the year, month, and day of the research session, such as <span class="u-nowrap">`2023-10-20`</span>.
To sort folders chronologically, the first part of the name should be the year, month, and day of the research session, such as <span class="u-nowrap">`2023-10-20`</span>.

Since multiple research sessions can occur in the same day, it is more precise to also include the time of the session. The time can be formatted in 24-hour "military" format to guarantee correct sort order, such as `1330` meaning <span class="u-nowrap">`1:30 PM`</span>.
Since multiple research sessions can occur in the same day, it is more precise to also include the time of the session. The 24-hour "military" time format guarantees correct sort order. `1330` means <span class="u-nowrap">`1:30 PM`</span>.

The researcher is more likely to remember details about the participant than the time the session occurred. So, the third part of the folder name should include the participant's name.

Expand All @@ -55,9 +55,9 @@ In this format, it is easy to notice there was over a two-month gap between sess

## 4. User research projects

User research projects should also be organized with folders, because they can also involve multiple files, such as the research plan, research report, recruitment templates, etc. Similar to the user research session folder names, project folder names should include the date the project started and a description of the project. If a project is related to a specific issue in the team's ticket tracking system (such as Jira), then that reference (e.g. <span class="u-nowrap">`ST-2740`</span>) should be included in the description. For example:
User research projects should also be organized with folders, because they can also involve multiple files, such as the research plan, research report, recruitment templates, etc. Similar to the user research session folder names, project folder names should include the date the project started and a description of the project. If a project is related to a specific issue in the team's ticket tracking system (such as Jira), then that reference (e.g. `#2740`) should be included in the description. For example:

- `2023-05-22 ST-2740 User Interviews`
- `2023-05-22 #2740 User Interviews`
- `2023-06-27 Prototype Feedback 1`
- `2023-08-01 Prototype Feedback 2`

Expand Down Expand Up @@ -91,10 +91,10 @@ Each page in Figma may contain any number of interactive "flows." [Figma flows](

The development team may organize their work according to user stories in a ticket tracking system. To align with the team, the designer can create a unique flow for each user story that a development team needs to understand, implement, and verify the work. The links to these flows can be included in the user story. Flows can be labeled with the unique reference number and short description of its corresponding user story. For example:

- `ST-2933 Create item`
- `ST-2934 View item`
- `ST-2935 Edit item`
- `ST-2936 Delete item`
- `#2933 Create item`
- `#2934 View item`
- `#2935 Edit item`
- `#2936 Delete item`

## Conclusion

Expand Down

0 comments on commit 6971e03

Please sign in to comment.