Skip to content

Commit c87aa36

Browse files
committed
solves #34
1 parent 6b87cd5 commit c87aa36

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

stylebook/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ In the short term, this book surely will undergo massive changes and reorganizat
1515

1616
In the long term, the book should settle down and become primarily a resource for developers and designers to refer to. Most links should be removed.
1717

18+
Note: The stylebook is a catalog of _guidelines_. These are not hard laws to be followed. The overarching principle is to make the user interface intuitive and welcoming. If blindly following a guideline does not serve that purpose, then ignoring the guideline is acceptable. However, the _right answer_ is to refine the guideline here to account for what has been learned.
19+
1820
## Parts of the UI
1921

2022
![The FreeCAD UI and its elements](ui.png)
@@ -269,6 +271,14 @@ FreeCAD has a major terminology problem for new users. We have a Part workbench
269271

270272
There should be one -- and preferably ONLY one -- obvious way to do a task. Developers are notorious for giving users options thinking that is a good thing. In reality, every tool takes time to understand. Given two nearly identical implementations of the same workflow, the user has to figure out how they differ. Don’t make the user think.
271273

274+
Never present the user with an enabled tool that is broken, non-functional, or cannot be used in the current context. Some examples:
275+
- It should not be possible for the user to initiate the 'export' operation
276+
without a document open because there is nothing exportable.
277+
- A workbench which requires the user to install something extra to be useful
278+
should not be part of the workbench switcher if the extra thing is not installed.
279+
- A toolbar tool that groups related tools together should be disabled if all
280+
the sub-tools are disabled.
281+
272282
## Resources
273283

274284
Here are some resources concerning UI/UX design.

0 commit comments

Comments
 (0)