diff --git a/Notebook-UX-Review-Template.md b/Notebook-UX-Review-Template.md new file mode 100644 index 0000000..f5fdd47 --- /dev/null +++ b/Notebook-UX-Review-Template.md @@ -0,0 +1,36 @@ +# Notebook UX Review Template +Use this template to review notebooks using the UX guidelines. + +## Instructions +- Open the notebook you're reviewing in another tab or split window. +- Use the table below to summarize UX alignment. +- Mark each guideline as: + - โœ… Meets expectations + - ๐Ÿ”น Could be improved + - โŒ Missing + - โž– Not applicable +- Add a short note in the *Suggestion* column for action items. +- Submit it as a comment in a PR + +## UX Structure Review Summary + +โœ… = (Meets expectations) +๐Ÿ”น = (Could be improved) +โŒ = (Missing) +โž– = Not applicable + +| Guideline | Status | Suggestion | +|-----------|--------|------------| +| Clear Header | โœ…๐Ÿ”นโŒโž– | Clear, succinct title (<15 words) of notebook's purpose | +| Goal/Objective Present | โœ…๐Ÿ”นโŒโž– | Brief summary (1โ€“2 lines) of what the notebook does and why | +| Setup & Pre-Requisites | โœ…๐Ÿ”นโŒโž– | Includes installation steps, required files, and environment assumptions | +| Section Headers/Markdown | โœ…๐Ÿ”นโŒโž– | Each code cell/section is preceded by a markdown block explaining its purpose | +| Handle Errors or Outputs | โœ…๐Ÿ”นโŒโž– | Highlights expected outputs or common errors (e.g. YAML structure, missing files, etc...) | +| Hardcoding Avoided | โœ…๐Ÿ”นโŒโž– | Uses variables or config for file paths instead of hardcoded strings | +| Concise Cells | โœ…๐Ÿ”นโŒโž– | Breaks logic into manageable chunks; avoids long, dense blocks | +| Code Commenting | โœ…๐Ÿ”นโŒโž– | Inline comments clarify non-obvious logic or structure within code cells | +| End Wrap-Up & Handoff | โœ…๐Ÿ”นโŒโž– | Notebook ends with a summary and/or next step guidance | + +--- +### Reviewer Notes (Optional) +Leave additional comments or clarifications here. \ No newline at end of file