Skip to content

Commit 713e095

Browse files
authored
Add doc and process for tracking dev questions for users (#92)
1 parent 1c9cdb7 commit 713e095

2 files changed

Lines changed: 17 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,3 +144,7 @@ Every function and method — exported or internal — must have a JSDoc block w
144144
- `@throws` for every error condition the caller must handle; omit if the function never throws.
145145

146146
Type declarations (interfaces, type aliases, enums) must have a JSDoc summary on the type itself and on each field or member whose purpose is not self-evident from its name and type.
147+
148+
## UX decisions
149+
150+
When key UX decisions are being made, discuss with a developer whether something should be added to `user-questions.md` for review with people outside the development team.

user-questions.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
This document is for things about which the dev team wants feedback from users or other stakeholders.
2+
3+
As decisions are needed in development, the developer should feel free to make the decision and add section in this document for external engagement. This _ex post facto_ review prevents unnecessary development delays.
4+
5+
If there are two options we want users to choose from, a pr can include a switch at the top of the extension for toggling between the options in demonstration. The switch is to be removed later after a final decision is made. (We are free to do this on the `main` branch until we make our first public release.)
6+
7+
## Topic Template
8+
9+
Description of thing needing decisions.
10+
11+
Explicit questions and/or clear list of options. Use multiple questions as needed: combining distinct factors into a single question leads to incomplete or confusing answers.
12+
13+
List of relevant GitHub issues/prs/commits.

0 commit comments

Comments
 (0)