To keep keywords consistent, I’ll define them here. For example, a mistake that might happen is that one calls the ZBrush SubTool, “sub tool” instead of “SubTool”.
Some examples why this is important:
-
Inconsistencies like this can lead to confusion. For example, ZBrush has something called a “Tool” emphasis on the capital T, seeing this immediately show the reader that the ZBush Tool is being talked about and not the English word “tool”.
-
It also makes it harder to search for terms in the handbook with the search bar or Ctrl+F.
| Keyword | What it refers to |
|---|---|
| SubTool | Every model in ZBrush has so called “SubTools” |
| Tool | The entire model in ZBrush is called “Tool” (and has SubTools inside of it) |
| SubDiv | There are many names for the Subdivision Surface Algorithm which is used in every 3D modeling software, I’ll call it SubDiv no matter how the software I’m currently talking about calls is. Occasionally I’ll also use the full name. |
| polypaint | |
| topology | Don’t use Topo??? |
| real-time | |
| hyper-realistic | |
| MatCap | |
| 16 bit | Keep the number and unit separate. |
| 16 px | Keep the number and unit separate. |
| film industry | |
| game industry | Try to avoid using an “s”, to keep the term consisent when used beside “film industry”. |
| capitalize software names | |
| vertex & vertices | |
Bold for keywords and code block for buttons and UI paths and hotkeys. Don’t always use code blocks for hotkeys | |
Settings > Path | Use arrow to show navigation through menus, make sure tho keep one space distance between the arrows. Surround hotkeys with a code block. |
Ctrl + F / Ctrl + F | Surround hotkeys with a code block. |
It’s also good for the above mentoined reason to not abbreviate terms, a list of terms that are often abreviated are:
Acronims are fine.
| Long | Short |
|---|---|
| topology | topo |
| triangles | tris |
| modifier | mod |