Analytica Docs guidelines

Guidelines and conventions for wording and formatting this Analytica wiki.

Reference resources

Headings

The main title of each page (including this) is a level 1 heading, in dark red bold.

The page title is also used as a link to this page from other pages.

First letter must be uppercase. Subsequent words should be lowercase unless they are proper names.
Keep page titles brief: E.g.

"Modules", not "How to use modules"

Other headings should be level 2 or lower, e.g. <nowiki>

== Level 2 heading ==
=== Level 3 subheading ===

(Currently, many Analytica wiki pages include level 1 headings within the page. These should be demoted to level 2 or lower.)

Capitalization

Analytica function names, classes and system words should be capitalized -- e.g. Sum, Variable, Index, Samplesize.

Key Analytica concepts or user interface elements should be capitalized -- e.g. Intelligent Arrays,

Key user interface elements should be capitalized -- e.g. Diagram, Uncertainty view, Toolbar.

Analytica

This is the Analytica wiki. Almost all content relates to Analytica. So there's no need to mention "Analytica" except when explicitly contrasting usage in Analytica to other modeling software or languages -- e.g. "Unlike most computer languages, subscripting in Analytica requires you to name each Index (dimension), but doesn't care about the sequence of dimensions. So, Analytica uses: X[I=2, State='CA']not X['CA', 2]."