Skip to content

Edit your Status profile #603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

Conversation

cheny0
Copy link
Contributor

@cheny0 cheny0 commented May 9, 2023

No description provided.

@cheny0 cheny0 added doc-new Additions to the Status documentation E:ProfileSettings Status profile and settings labels May 9, 2023
@cheny0 cheny0 requested a review from jorge-campo May 9, 2023 07:43
@cheny0 cheny0 self-assigned this May 9, 2023
@cheny0 cheny0 modified the milestone: MVP May 9, 2023
@cheny0 cheny0 linked an issue May 9, 2023 that may be closed by this pull request
Copy link
Contributor

@jorge-campo jorge-campo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @cheny0 – This content looks simple, but it takes a while to produce it.

Here are my review comments and a final experiment I ran with your content.

About the content

  1. The name in Miro was 'View and edit your profile'. I updated Miro with 'View and edit your Status profile'.

  2. Minor thing about the admonition at the beginning of the document: 'Currently, some sections are not editable...' -> 'Currently, some profile sections are not editable...'

  3. As discussed in the 'View your profile as someone else' topic, the 'What to expect' section only makes sense in articles where we want to summarize all the content for the reader. I don't think this is the case. I'd take the information in 'What to expect' and integrate it into the introductory paragraph.

  4. In the intro to the procedure, you say, 'You can edit four types of content...' I would remove this information and add the following note-type admonition: 'You can only edit your communities, accounts, collectibles or assets information in Status mobile.'

About the structure:

  1. Your content structure can improve a bit. Notice that you use an H2, 'Edit your Status profile' and add links in a table. Then, you add the procedures for each link as additional H2s. This approach puts everything at the same level, both visually and hierarchically.

In reality, you want your H2 headers after 'Edit your Status profile' inside this H2. In other words, you need to change the H2s to H3s, starting with 'Edit profile picture'.

  1. You write the same table twice; why? You can write the table once outside of the ==Mobile and ==Desktop. The document layout will not change, but your Markdown file will look cleaner.

Screenshot 2023-06-01 at 5 50 41@2x

  • Edit your Status profile

    • Avatar -> Profile picture (I'll integrate this change in a future style guide update).
    • We don't use section when discussing the UI; we use area .(see https://write.status.im/style-conventions/#name-conventions). You used the word 'section' in the intro, and that's OK because you're not in a procedure describing the UI.
    • '… and follow the corresponding procedure' -> '… and follow the corresponding procedure from this table.'
    • In your table, 'section' would be 'Area to edit' and 'works with' would be 'Availability' (I think 'works with' is not the right wording here). Then, you can remove the 'Edit' word from every link and H3 header.
    • In the desktop section, you're missing a word in the first step: 'From the navigation sidebar, click Settings...'
    • Use the same 'Choose the …' sentence in both mobile and desktop. If the step serves the same function, use the same text (it makes things look tidy).
  • Edit profile picture -> Edit your profile picture

    • Avatar -> Profile picture

Experiment

I experimented with an alternative approach to structuring the content, but after a second thought, I think it's not a good option. Honestly, I don't know; it looked simpler in my head, but it feels a bit convoluted in its implementation. On the one hand, these are relatively simple procedures, and I don't think users may look at this content frequently. On the other hand, if I scroll in my phone to the point of, for example, 'Manage web links', this section seems disconnected from the section where we tell the user how to get there (the user needs to scroll back, but they may have missed this). In other words, the initial procedure where we tell the user where to find the options is far from the procedure to change the option in the page.

I share a short video of the idea here and the Markdown file (see link below, view-and-edit-your-status-profile-alternative.md). Maybe you can share your approach and my approach with the team and ask them for feedback. I changed the wording a bit to make the tabs shorter. My only concern is how this looks on a smartphone. You can try pushing the changes to develop and use your phone; I haven't gone that far due to the lack of time.

With this approach, you don't need the initial table or links to each section, and you can forget about the H2 and H3 hierarchy I discussed before.

Screenshot.2023-06-01.at.6.52.12.mp4

view-and-edit-your-status-profile-alternative.md

@cheny0
Copy link
Contributor Author

cheny0 commented Jun 6, 2023

Thanks @jorge-campo. I have applied the comments and merged the updates. Regarding the structure change, I created an update issue #658 .

@cheny0 cheny0 closed this Jun 6, 2023
@cheny0 cheny0 deleted the 531-edit-your-status-profile branch June 21, 2023 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-new Additions to the Status documentation E:ProfileSettings Status profile and settings
Projects
Status: Published/Done
Development

Successfully merging this pull request may close these issues.

View and edit your Status profile
2 participants