MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.26k stars 21.43k forks source link

Clicking on JavaScript on the same page takes you to an unrelated page. #61899

Closed Yonet closed 4 years ago

Yonet commented 4 years ago

JSDocs

Scenario:

I am looking for JavaScript documentation for Cognitive Services on their page and have 2 JavaScript options. Link 1 Link 2 If I click on link 2, I am redirected to a different page. It is hard to find the Cognitive Services and confusing to end up in different sidebar navigation.

This is consistent throughout the documentation. I can see why it is useful in some cases to be able to go to language-based selection but at the same time, I have lost what I was looking for, Cognitive Services.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

kobulloc-MSFT commented 4 years ago

@Yonet Thank you for the feedback (and the screenshot)!

This is a design decision made for all of Azure and closely resembles what you'll see in other product pages, like Office. I'll pass your feedback along but for now it may be valuable to get familiar with the documentation layout as it can take a little getting used to. Once you know what to look for and where, using the documentation quickly becomes second nature and can be a valuable resource.

image

Each row in the top navigation takes you a layer closer to the product and service that you are looking at. Within the actual documentation itself, you may see options for changing instructions and code samples to match the language you are interested in (JavaScript, in this case).

Selecting "Develop" from the 2nd row will give you Azure wide results. For service specific results in your language, you'll typically want to check one of 3 places:

Yonet commented 4 years ago

Thank you @kobulloc-MSFT. I'm an msft employee and very familiar with the structure. We are looking at the reasons why and where new user churn is happening and how we can improve the retention rates. I am working on a end to end scenarios where a user come to the documentation with a goal to do something and how easy it is to accomplish that goal without getting lost in documentation. Although it is a design decision, it is very confusing for an unfamiliar user to end up on azure JavaScript docs while they are browsing in cognitive services documentation and looking for JavaScript SDK.

I know it is not an improvement that will happen tomorrow but we have to file the issue to keep track of the feedback.

Thanks!

kobulloc-MSFT commented 4 years ago

@Yonet Thank you for working to improve our documentation experience! I'm going to close this as there's no additional action we can take on our end, but it will remain visible for tracking purposes. If you need this reopened, just tag me in your reply and I'd be happy to adjust the issue accordingly.

Yonet commented 4 years ago

@kobulloc-MSFT Can we keep it open to keep track until to make sure we give the feedback to the docs team and we get a response. Closing defeats to purpose of giving the feedback. Thanks.

kobulloc-MSFT commented 4 years ago

@Yonet No worries! Just tag me in a reply when you are ready to close this.

Yonet commented 4 years ago

@kobulloc-MSFT thank you.

nitinme commented 4 years ago

@Yonet - A good approach would be to create a work item in the tracking tool that you use, e.g. Azure DevOps, add a link to this Github issue in that work item, and close this work item. We are actively looking to close Github issues on our content, driving them to resolution, and have SLAs towards it. For long running issues, like this one, the approach we follow is what I have recommended here.

please-close

Yonet commented 4 years ago

Hi @nitinme, I can save the link for the issue but my question is, how will I know if the doc team has a solution or not going to fix? If there is a DevOps for the azure docs team, please direct me there. The only way I know I can give feedback to the documentation team is through github issues.

Thanks!