How to write good articles

  • 更新日 May 15, 2020
  • 公開日 May 15, 2020
  • 1 分で読めます
Prev Next
This content is currently unavailable in Ja - 日本語. You are viewing the default (English) version.

This is an internal guide on how to write good documentation articles:

  1. Keep the chunks of instructions small and focused. Split each task into its own article. This helps search-ability.
  2. Use descriptive URL slugs - for example, if something is platform specific, make sure that platform is part of the URL slug (eg, salesforce-apex-permissions instead of just apex-permissions)

  3. When using any images on the page, please enable the "rounded" and "shadow" styles


  4. If using multiple images on the article, please set the width to be the same for all images so that it looks consistent and professional.