Report a bug in manual link is not really visible and does not describe what it is there for #92804

New Issue

Johannes Kollmer · 2021-11-03T23:52:13+01:00

Johannes Kollmer commented

2021-11-03 23:52:13 +01:00

Pagename: All Pages
Blender Version: All Versions
Documentation Language: en
Permanent link

Short description of error
It came up in a thread on Blenderartists.org that the "Report Bug" button in the Blender manual could be used for all kinds of improvement, ranging from reporting typos to submitting whole new paragraphs with images and things like this.

https://blenderartists.org/t/a-discussion-on-blender-documentation/1335976/32

Reporting a bug does generally not carry this meaning and I believe that many people are unaware of this possibility to contribute to the documentation because of that.

Furthermore, the button is in a place where it is nearly invisible, right after the copyright which most people probably never read.

Suggestion:

Rename "Report bug" to "Suggest Improvement" or something more descriptive
Place the button in a more prominent place on every page
Temporarily place it in large red letters on top of each page with short instructions of what the button is there for until awareness of this contribution possibility has been increased.

Pagename: All Pages Blender Version: All Versions Documentation Language: `en` [Permanent link ](https://docs.blender.org/manual/en/2.93/index.html) **Short description of error** It came up in a thread on Blenderartists.org that the "Report Bug" button in the Blender manual could be used for all kinds of improvement, ranging from reporting typos to submitting whole new paragraphs with images and things like this. https://blenderartists.org/t/a-discussion-on-blender-documentation/1335976/32 Reporting a bug does generally not carry this meaning and I believe that many people are unaware of this possibility to contribute to the documentation because of that. Furthermore, the button is in a place where it is nearly invisible, right after the copyright which most people probably never read. Suggestion: 1. Rename "Report bug" to "Suggest Improvement" or something more descriptive 2. Place the button in a more prominent place on every page 3. Temporarily place it in large red letters on top of each page with short instructions of what the button is there for until awareness of this contribution possibility has been increased.

Johannes Kollmer commented

2021-11-03 23:52:13 +01:00

Added subscriber: @Lumpengnom-3

Pratik Borhade commented

2021-11-04 10:22:07 +01:00

Added subscribers: @Blendify, @PratikPB2123

Pratik Borhade commented

2021-11-04 10:22:07 +01:00

Hi, Thanks for the report I guess This can be improved as discussed in the thread.

@Blendify , do you have any opinion on this?

Hi, Thanks for the report I guess This can be improved as discussed in the thread. @Blendify , do you have any opinion on this?

Tobias Heinke commented

2021-11-11 08:02:32 +01:00

Added subscriber: @Tobias

Tobias Heinke commented

2021-11-11 08:02:32 +01:00

I worried that bug is too technical. But it established umbrella term in tech writing. Others are too long. But maybe a tooltip could be it like:

 "Report typos, errors and suggest improvements   on this page"

We had it on the right of the breadcrumbs, but it then wraps long crumbs.
That would be in the way/annoying on every page because it can't be one-click hidden without cookies (I think). Making the the link red could help (icon only has to much contrast, separates icon and text).

1. I worried that bug is too technical. But it established umbrella term in tech writing. Others are too long. But maybe a tooltip could be it like: ``` "Report typos, errors and suggest improvements on this page" ``` 2. We had it on the right of the breadcrumbs, but it then wraps long crumbs. 3. That would be in the way/annoying on every page because it can't be one-click hidden without cookies (I think). Making the the link red could help (icon only has to much contrast, separates icon and text).

Johannes Kollmer commented

2021-11-11 09:47:40 +01:00

I think one main problem is the placement. IMO it is not very discoverable if it is at the end of the page right after the copyright link.
A tooltip is great if you get people interested so that they hover over the link long enough.

How about a button similar to the "next" and "previous" buttons but on the right side next to the title. Perhaps even in one of the colors used in the manual for tips, warnings, see also...

Here are some mockups:

I think one main problem is the placement. IMO it is not very discoverable if it is at the end of the page right after the copyright link. A tooltip is great if you get people interested so that they hover over the link long enough. How about a button similar to the "next" and "previous" buttons but on the right side next to the title. Perhaps even in one of the colors used in the manual for tips, warnings, see also... Here are some mockups: ![BlenderManual_SuggestImprovement.jpg](https://archive.blender.org/developer/F11793106/BlenderManual_SuggestImprovement.jpg) ![BlenderManual_SuggestImprovement_TT.jpg](https://archive.blender.org/developer/F11793108/BlenderManual_SuggestImprovement_TT.jpg) ![BlenderManual_SuggestImprovement_TT_Gray.jpg](https://archive.blender.org/developer/F11793110/BlenderManual_SuggestImprovement_TT_Gray.jpg)

Aaron Carlisle commented

2022-01-24 20:36:18 +01:00

Changed status from 'Needs Triage' to: 'Resolved'

Aaron Carlisle closed this issue

2022-01-24 20:36:18 +01:00

Aaron Carlisle self-assigned this 2022-01-24 20:36:18 +01:00

Aaron Carlisle commented

2022-01-24 20:36:18 +01:00

We have had issues in the past where this button was used to describe general bugs in Blender rather than the documentation.

I clarified this in rBM8844 by changing the text to "Report issue on this page"

There are some long-term plans to change the web theme, until then, I am leaving the placement where it is.

We have had issues in the past where this button was used to describe general bugs in Blender rather than the documentation. I clarified this in rBM8844 by changing the text to "Report issue on this page" There are some long-term plans to change the web theme, until then, I am leaving the placement where it is.

Sign in to join this conversation.

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Report a bug in manual link is not really visible and does not describe what it is there for #92804