> For the complete documentation index, see [llms.txt](https://handbook.chaoss.community/community-handbook/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://handbook.chaoss.community/community-handbook/contributing/documentation/style-guide.md).

# Style Guide

In order to keep our documentation consistent across various spaces, we ask that you respect the following conventions and best practices when contributing documentation to the CHAOSS community.

Try to keep your writing clear and concise. Your explanations should be comprehensive, but easy to follow. The more precise your writing is, the easier others will find it to follow. 

Here are some general guidelines and reminders for tone and style:

* Write accessibly in clear, simple sentences intended for a global audience.
* Avoid colloquial language, humor, cultural references, and personal opinion. Keep your writing technical.
* Write from a second-person point of view. Use "you" and "your", not "my", "our", or "their".
* Avoid jargon and acronyms, if you can. Spell out acronyms at least once per page.
* Remember to link to glossary terms when first introducing them in a paragraph.
* Be consistent. Use the same consistently-formatted word or phrase for a concept throughout the documentation.
* Don't qualify or prejudge actions. Don't write that something is "easy" or "quick" as this is a deterrent if the user is not able to complete the action.
* Don't reference future development or features that don't yet exist.
* Remember to use sentence case for page titles and section headings.
* Use numbered lists for actions that happen in sequence.
* Use bulleted lists for most other lists.

{% hint style="info" %}
**Source Citation:** This page has been taken and inspired by the Atom documentation under the "Writing Style Guide" section <https://wiki.accesstomemory.org/wiki/Resources/Documentation/Contribution_guidelines#Writing_style>
{% endhint %}


---

# 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://handbook.chaoss.community/community-handbook/contributing/documentation/style-guide.md?ask=<question>&goal=<endgoal>
```

`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.