Skip to content

Conversation

@ahoneybun
Copy link
Contributor

@ahoneybun ahoneybun commented Jun 20, 2023

Address feedback from a support ticket and helps promote tech-docs.

Change:

Screenshot from 2023-06-20 09-11-20

@ahoneybun ahoneybun requested review from a team and thomas-zimmerman June 20, 2023 15:05
Copy link
Contributor

@thomas-zimmerman thomas-zimmerman left a comment

Choose a reason for hiding this comment

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

LGTM

@Raikiri
Copy link

Raikiri commented Jun 20, 2023

I honestly don't see how reading the technical documentation is relevant to "Contacting us", but a link to https://support.system76.com/articles/guides should definitely be somewhere on the most visible location of https://support.system76.com/

If anything, I'd drop some of those "Troubleshoot"/"Tune"/"Learn", fake links because they look like they can take you somewhere interesting, but instead they just scroll the page down, so that you also have to scroll back up to try other links just to find out that they too scroll you all the way down. In my opinion, links should be links, and table of contents needs to look like table of contents.

@ahoneybun
Copy link
Contributor Author

I honestly don't see how reading the technical documentation is relevant to "Contacting us", but a link to https://support.system76.com/articles/guides should definitely be somewhere on the most visible location of https://support.system76.com/

If anything, I'd drop some of those "Troubleshoot"/"Tune"/"Learn", fake links because they look like they can take you somewhere interesting, but instead they just scroll the page down, so that you also have to scroll back up to try other links just to find out that they too scroll you all the way down. In my opinion, links should be links, and table of contents needs to look like table of contents.

Perhaps the "Contacting Us" section is not the best but looking for the tech-doc and finding them is difficult. With this location it could be used to locate them so that folks do not need to ask about where they are. I don't know about removing that "fake" links since they can be used to move to a certain section quickly and they are useful.

Copy link
Member

@leviport leviport left a comment

Choose a reason for hiding this comment

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

I do have to agree with @Raikiri about the location of this being rather awkward since it's pretty unrelated to contacting us. I think it would be best to add a section in the "Before you open a ticket" article. The left column would kinda work, but it still feels a bit awkward and out of place.

What do you think of adding a section to the "Before you open a ticket" article?

@Raikiri
Copy link

Raikiri commented Jun 22, 2023

Putting it into "Before you open a ticket" is basically putting into the last possible place somebody might want to check right before creating a ticket that says "I can't find your technical documentation". So no, I don't think it's a good place either, I think the link needs to be much closer to the topmost location in the navigation hierarchy, maybe even put it into the header:
image

Alternatively, "Support articles" seems like a really logical place for the list of support articles to be.

@ahoneybun
Copy link
Contributor Author

@Raikiri that location would not be part of the docs project and instead with the web team so it's not an option at least from this PR.

@leviport
Copy link
Member

Putting it into "Before you open a ticket" is basically putting into the last possible place somebody might want to check right before creating a ticket that says "I can't find your technical documentation".

I meant that question for Aaron, but thanks for the input. My impression is that's pretty much the exact idea we were going for. This is a link to a support article that has various links to tech-docs for each model. I believe having that support article amongst the rest is still sufficient, but I agree with Aaron that it can probably be improved. Adding a link to a support article into the header for the whole site, next to a link to the list of support articles, is not something I'm super keen on. And we certainly wouldn't be able to get Marketing, Web, Sales, etc. on board with such a change either.

@Raikiri
Copy link

Raikiri commented Jul 3, 2023

Another thing I wanted to mention: if it's going to be named "Find Documentation For Your Model" among a million other articles, I expect it to be very hard to find: maybe it's a me problem, but when I want to repair my laptop, I never search for "Documentation", I search for "repair guide", " internal view", "disassembly", etc. "Documentation" strikes me as data sheets/specs/warranty-disclaimers-on-69-languages rather than a guide.

Pardon me if I sound too nitpicky and I don't really have a solution to this problem. I'm just providing you a data point of my own experience: since from my past experience I know that you guys have this documentation, after some struggle I do manage to find it every time I need it. But if I was on your page for the first time, a good chance I wouldn't be able to.

@leviport
Copy link
Member

leviport commented Jul 3, 2023

I search for "repair guide", " internal view", "disassembly", etc.

That's a good point, and I think it'd be good to add those to the search terms for that article. "Components" and "guide" both bring it up, but adding more terms is easy enough.

@ahoneybun
Copy link
Contributor Author

@leviport @Raikiri I've made some changes so if you want to give this another review let me know.

@ahoneybun ahoneybun requested a review from leviport July 6, 2023 14:53
@ahoneybun ahoneybun requested a review from leviport July 6, 2023 17:13
@leviport leviport force-pushed the promote-tech-docs branch from 928d43e to c14ac1a Compare July 6, 2023 17:15
@leviport
Copy link
Member

leviport commented Jul 6, 2023

(I just removed a stray space that was left over from where those keywords were deleted)

@Raikiri
Copy link

Raikiri commented Jul 7, 2023

I still can't find the documentation while searching for "repair guide" or "internal view". Even if I do stumble upon "Documentation for your model", it's not immediately obvious that it's what I'm looking for. But it's obviously better than none at all.

@ahoneybun
Copy link
Contributor Author

I still can't find the documentation while searching for "repair guide" or "internal view". Even if I do stumble upon "Documentation for your model", it's not immediately obvious that it's what I'm looking for. But it's obviously better than none at all.

The keywords do not effect the search, it seems to be based on title and description.

Copy link
Contributor

@thomas-zimmerman thomas-zimmerman left a comment

Choose a reason for hiding this comment

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

Let's get this change live and see if this helps. Changes look fine on the live view.

@ahoneybun ahoneybun merged commit 6eb1e1b into master Sep 18, 2023
@ahoneybun ahoneybun deleted the promote-tech-docs branch September 18, 2023 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants