> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/1.2/user-guides/documentation-guides/documentation-guidelines.md).
# 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
* Start a topic with Introduction/Concept/Context
* 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 lowercase 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.
* For work-in-progress features/functions, you may mention the same under the title as shown below:
* Check spelling and grammatical corrections using tools such as Grammarly.
## 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 bold and 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.
## Specification for diagram
Follow the below specification while creating diagrams in Miro
{% embed url="" %}
Diagram specification
{% endembed %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.openg2p.org/1.2/user-guides/documentation-guides/documentation-guidelines.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.