use capitalization conventions taken from the application to which the guide refers. When in doubt, seek clarification from the developers. If you cannot seek clarification from the developers, choose the most natural convention. In all cases, be consistent. Artstor should not become ARTstor mid-guide.
eg: NowComment, WordPress, and Artstor follow corporate capitalization conventions. When WordPress refers to the Dashboard, it’s always capitalized.
do not hyphenate
let readers know they're about to leave the Knowledge Base. Use one of two options:
- Write out the URL. Use this option if the link is short, and used in a "Go to" step. Check out this example.
- Add "external" to the text introducing the link. Use this option if the link happens in a "Learn more" note or addendum. Check out this example.
use instead of campus; always capitalized
eg: First create your account on Grounds.
do not capitalize
always italicize the link
log in, login
"log in" is a verb, "login" is a noun
eg: I tried to log in, but I forgot my login password.
page titles and static items
these are names of items that cannot be clicked within the application (that is, names of non-links). Always write these names in quotation marks.
eg: The “About” page contains background information. Check the box next to “Allow comments.”
Knowledge Maps, subjects, places
Knowledge Maps (always capitalized) is the name for Mandala's system of content labeling. Knowledge Maps can currently be subjects or places.
abbreviation of University of Virginia; all letters capitalized, contains no periods
address the reader directly. If, however, the reader needs to know about people that interact with his/her project, call these people "your viewer" or "your audience." Avoid user, which is impersonal and reflects the development of the tool.
Mandala Visuals is the official name for the Mandala tool that creates data graphics. These graphics are called visualizations.
eg: You can share visualizations with Visuals.