meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
doc_standards [2025/06/07 15:31] – created wrongechodoc_standards [2025/06/07 16:01] (current) – c/e wrongecho
Line 3: Line 3:
 We'd like to maintain a consistent look and feel for this documentation at docs.itflow.org. If you choose to [[contribute|contribute]] to our documentation, please try to follow these guidelines: We'd like to maintain a consistent look and feel for this documentation at docs.itflow.org. If you choose to [[contribute|contribute]] to our documentation, please try to follow these guidelines:
  
-  * Page titles and main headings should start with a level 1 headline, i.e. <nowiki>====== Title ======</nowiki> +  * Page titles and main headings should start with a level 1 headline, e.g. <nowiki>====== Title ======</nowiki> 
-  * Subheadings should utilize level 2 and level 3 headlines, i.e. <nowiki>===== Subheading under a topic =====</nowiki>+  * Subheadings should utilize level 2 and level 3 headlines, e.g. <nowiki>===== Subheading under a topic =====</nowiki>
   * Use bold text to indicate actions, e.g. <nowiki>Select **yes** to continue</nowiki>   * Use bold text to indicate actions, e.g. <nowiki>Select **yes** to continue</nowiki>
   * Use italics to add emphasis   * Use italics to add emphasis
   * Code, PHP variables and commands should be placed into codeblocks, e.g.  <nowiki>''$dbhost''</nowiki>   * Code, PHP variables and commands should be placed into codeblocks, e.g.  <nowiki>''$dbhost''</nowiki>
-  * Be simple, direct and to the point+  * Be simple, direct and to the point - write for a human
   * Avoid using emojis   * Avoid using emojis
   * When you need an example domain, use itflow.yourdomain.com   * When you need an example domain, use itflow.yourdomain.com
 +  * Include useful edit summaries