Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: add markup/markdown entry

...

  •  Articles should be written using formal, professional, and concise language. Care should be taken to remove grammar and orthography errors through edit previews and proofreading.
  •  Avoid contractions: "don't", "isn't", "you've", etc. should be "do not", "is not", and "you have", for example.
  •  Avoid unnecessary shortening of word. In case of acronyms, when first use in a page, write the full name instead.
  •  Avoids unnecessary capitalization", so use sentence case (like "Writing style" above) in page titles, section headings, table headings, and captions.
  •  Talk directly to the reader: do not hesitate to use "you" or "we".

  •  Do not use indefinite time references such as "currently", "at the time of writing" or "soon"; replace them with definite expressions such as "as of May 2016" etc.
  •  Write objectively: do not include personal comments on articles. In general, do not write in first person.
  •  When editing content, be consistent with the style used in the rest of the article.

 

Text formatting

Markup

You can type wiki markup directly into the editor, and Confluence will convert it as you type.

Example: _this is italic style

 

Markdown

Confluence supports inserting content in markdown.

To insert markdown in the editor:

  1. Choose Insert > Markup
  2. Select Markdown
  3. Type or paste your text - the preview will show you how it will appear on your page
  4. Choose Insert.

Highlighting

 

  • Do not mix more than one highlighting method.
  • The first relevant appearance of a term or name in an article can be highlighted  if regarded as worthy of particular attention.
  • The preferable way of highlighting the name is using a link to a closely related article; if there are no possible pertinent links, bold can be used as a fallback solution.
  • No formatting shall be applied to the anchor text of links.

...