GITBOOK-73: No subject

SUMMARY.md

@@ -166,9 +166,9 @@
   * [Submit Reimbursement Using the Service Provider Portal](guides/user-guides/submit-reimbursement-using-the-service-provider-portal.md)
   * [Reimburse the service provider](guides/user-guides/reimburse-service-provider.md)
 * [Documentation Guides](guides/documentation-guides/README.md)
-  * [Creating Diagrams](guides/documentation-guides/creating-diagrams.md)
   * [OpenG2P Module Doc Template](guides/documentation-guides/openg2p-module-doc-template.md)
   * [Writing Guidelines For How-To Guides](guides/documentation-guides/writing-guidelines-for-how-to-guides.md)
+  * [Documentation Guidelines](guides/documentation-guides/documentation-guidelines.md)
 * [Deployment Guides](guides/deployment-guide/README.md)
   * [Deployment on Kubernetes](guides/deployment-guide/deployment-on-kubernetes/README.md)
     * [K8s Cluster Requirements](guides/deployment-guide/deployment-on-kubernetes/k8s-cluster-requirements.md)

guides/documentation-guides/documentation-guidelines.md

@@ -0,0 +1,28 @@
+# Documentation Guidelines
+
+## Introduction
+
+This guide provides basic guidelines for you to write neat documentation.
+
+## General conventions
+
+* Page title: Capitalize the first letter of every word. Like this page title
+* Check spelling and grammatical corrections using tools such as Grammarly.
+* Use Gitbook's "Heading 1, Heading 2" etc for headings
+* Headings must use lowercase except for the first letter. E.g. "Code of conduct"
+* Provide reference links to the text as applicable.
+* Provide a link at the first mention of a new/different topic. For example, if the guide is talking about installing the SmartScanner app, and the WireGuard app is mentioned, then provide the link for WireGuard.
+* Avoid using ":" in a heading.  E.g. "Design choices:" 
+* Use clear and crisp images - the images should not appear blurred when seen on full screen.
+* If you are adding image files, make sure all file names are lower case with hyphens. E.g `architecture-diagram.png`.
+* The filename for images should follow the naming convention of every word in lower case, and words separated by hyphens i.e. view-all-programs.png.
+
+## User guides
+
+In addition to the above while writing user guides follow these conventions:
+
+* Use second-person pronouns i.e. you, your, etc. in the instructions/steps.
+* Use the italicized font for UI elements i.e. dashboard names, button labels, information fields, etc.
+* Use the exact name and case for the UI elements as shown in the user interface.
+* Use quotes for a phrase/word if the phrase/word has to be represented as is.
+*