Conversation
✅ Deploy Preview for industrial-experience ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new, detailed guideline page that defines the UX writer role within the existing iX UX writing guidelines. The page clarifies the responsibilities, processes, and collaborative aspects of UX writing, aiming to standardize practices and ensure consistent, effective language across digital products. It covers how UX writing integrates with design, collaborates with other teams, utilizes design systems, adheres to governance, and fits into agile development cycles. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a new documentation page describing the role of a UX writer. The content is valuable, but I've identified several opportunities for improvement to ensure consistency with existing documentation. My feedback includes corrections to the file's frontmatter, formatting issues such as improper use of HTML tags and incorrect list structure, and suggestions to align with the established writing style, like using active voice. I've also noted that the document's section structure differs from the standard layout used in this repository.
| title: UX writer role | ||
| title: UX Writer role |
There was a problem hiding this comment.
The frontmatter has a duplicate title key, which is invalid YAML and can cause parsing issues. Additionally, the value UX Writer role violates the style guide's rule for sentence case in titles.
| title: UX writer role | |
| title: UX Writer role | |
| title: UX writer role |
References
- Style guide line 36: 'Use sentence case always: Start with a big letter and then only proper nouns are capitalized.' (link)
| UX writers strengthen usability, reduce friction and ensure every interaction across our software feels supportive and human-centered.<br/> | ||
| They shape in product language that supports a clear, seamless and intuitive user experience. |
There was a problem hiding this comment.
Using <br/> tags for line breaks is discouraged in Markdown. Please use empty lines between paragraphs to separate them. This improves the source code's readability. This issue occurs multiple times in the file (e.g., lines 18, 23, 24, 91, 96).
| UX writers strengthen usability, reduce friction and ensure every interaction across our software feels supportive and human-centered.<br/> | |
| They shape in product language that supports a clear, seamless and intuitive user experience. | |
| UX writers strengthen usability, reduce friction and ensure every interaction across our software feels supportive and human-centered. | |
| They shape in product language that supports a clear, seamless and intuitive user experience. |
|
|
||
| Design systems provide components, shared patterns and guidelines for consistent product language. They are used when writing microcopy, validate terminology before implementation and apply established patterns for consistency. | ||
|
|
||
| ### What's included |
There was a problem hiding this comment.
The style guide requires using the typographically correct apostrophe (’, U+2019) instead of a straight quote (').
| ### What's included | |
| ### What’s included |
References
- Style guide line 35: 'Apostrophe: Always use the symbol ’ (U+2019, "right single quotation mark"), not ''' (link)
docs/guidelines/language/support-and-resources/ux-writer-role.md
Outdated
Show resolved
Hide resolved
| Integrate UX writing throughout all Scrum phases to allow product language to evolve with the design.<br/> | ||
| * Sprint planning: Identify content needs and terminology early in ideation | ||
| * Daily standups: Stay aligned on interaction changes that affect microcopy | ||
| * Refinement: Collaborate with designers and product owners on wording decisions | ||
| * Development: Ensure accurate implementation and consistency | ||
| * Retrospectives: Refine the writing process based on team feedback<br/> | ||
| Continuous collaboration prevents terminology gaps, reduces rework and improves clarity throughout the product. |
There was a problem hiding this comment.
This list is not formatted correctly for Markdown. The <br/> tags are unnecessary and incorrect. Please format this as a standard Markdown bulleted list, with an empty line after it to separate it from the following paragraph.
| Integrate UX writing throughout all Scrum phases to allow product language to evolve with the design.<br/> | |
| * Sprint planning: Identify content needs and terminology early in ideation | |
| * Daily standups: Stay aligned on interaction changes that affect microcopy | |
| * Refinement: Collaborate with designers and product owners on wording decisions | |
| * Development: Ensure accurate implementation and consistency | |
| * Retrospectives: Refine the writing process based on team feedback<br/> | |
| Continuous collaboration prevents terminology gaps, reduces rework and improves clarity throughout the product. | |
| Integrate UX writing throughout all Scrum phases to allow product language to evolve with the design. | |
| * Sprint planning: Identify content needs and terminology early in ideation | |
| * Daily standups: Stay aligned on interaction changes that affect microcopy | |
| * Refinement: Collaborate with designers and product owners on wording decisions | |
| * Development: Ensure accurate implementation and consistency | |
| * Retrospectives: Refine the writing process based on team feedback | |
| Continuous collaboration prevents terminology gaps, reduces rework and improves clarity throughout the product. |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
tokyojen
left a comment
tokyojen
left a comment
There was a problem hiding this comment.
did the gemini review and resolved the two comments.
2 participants
🆕 What is the new behavior?
This is the new page UX writer role within Support and resources in the iX UX writing guideline.
👨💻 Help & support