search

StyleGuides / WritingStyleGuide

The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Creative Commons Attribution Share Alike 4.0 International
72 stars 20 forks source link

Add entry for "accordion" and "twistie" #71

Open daobrien opened 7 years ago

daobrien commented 7 years ago

Accordion is used by GLS and seems to be pretty common. IBM uses "twistie" for the same thing, but I've never heard of it. Need to come up with something suitable as an entry.

daobrien commented 5 years ago

IBM states:

Avoid in technical documentation, unless you need to specify the type of control being referred to. In general, refer to the control by its label only. Use “expand” to refer to clicking a twistie to display content. Use “collapse” to refer to clicking a twistie to hide content (for example, “Expand Properties”).

We can paraphrase to include "don't say accordion and just use the label." This basically aligns with the statements about menus and buttons: Rather than "Click the Save button" just say "Click Save" and so on.

Because these terms are uncommon (afaict) it would be a good idea to include an image.