As a team working on O3DE rev the engine test, we have come across several inconsistent and incorrect tool-tips messages in the editor.
Tooltip are located in many locations throughout the editor this includes; the animation system, asset browser, UI editor, outliner, inspector, main header, global settings, PhysX global settings, etc.
Fixing individual tooltips messages seems not like the best use of our time based on the number of issues we are seeing. This is because all tooltips text are stored inline and not centralized and thought about holistically. The AC for this project is as followed.
We would like for all of the tooltips in the editor to be combined into a centralized location for easy update.
This could be a TXT, XML, Excel or some kind of easily readable file(s). Developer needs to research best method.
We should include some rules about how we should be speaking to the customer. This should be reflected as comments in the beginning of this new document so as developers add to the document, they can read the rules before updating the text.
Rules needing to be confirmed by docs. William Hayward and Doug Erickson please give your thoughts to help confirm standards to reflect most recent writing practices.
We do not use camel case.
We only capitalize proper names, example, "Script Canvas."
First letter should always be capitalized.
periods should be used.
Text should be written in future tense. Not past tense.
Tooltip text should reflect what we are looking and how to accomplish that task.
Length of text should never exceed 1 paragraph of text. If text is longer than 1 paragraph we should be redirecting a customer to a secondary page to get more information. No specific standard set on where customer must go.
We should prepare this text to be localized into multiple languages.
This means we should be careful about terminology that could be misunderstood in different languages.
This task will also include pulling out all the tooltip text throughout the editor and replace it with some kind of common global variable.
We will also need docs to do a pass on all the tooltip text once it has been centralized into a file(s).
As a team working on O3DE rev the engine test, we have come across several inconsistent and incorrect tool-tips messages in the editor.
Tooltip are located in many locations throughout the editor this includes; the animation system, asset browser, UI editor, outliner, inspector, main header, global settings, PhysX global settings, etc.
Fixing individual tooltips messages seems not like the best use of our time based on the number of issues we are seeing. This is because all tooltips text are stored inline and not centralized and thought about holistically. The AC for this project is as followed.