# Writing guide

1\. Correctness

* Avoid common English language mistakes.
  * More details: [Writing: English language](/guides/learning-english/common-english-language-mistakes.md)

2\. Consistency, organization, and visual appearance

* Use consistent font face, color, and size.
* Use consistent casing.
* Use consistent punctuation.
  * For example, have a clear logic for using dots at the end of each bullet point phrase.
* Try use only one to three colors.

3\. Minimalism

* Keep only phrases and words that add significant meaning.

4\. Positivity

* Use positive words instead of negative where possible.

5\. Clarity

* Make sure the words you mention are known by the typical reader or make sure to explain them.
* Consider keeping abbreviations only for very commonly used terms in your field or for [searchability](https://en.wiktionary.org/wiki/searchable) (making sure your resume shows up for keyword searches). It looks like [Elon Musk](https://en.wikipedia.org/wiki/Elon_Musk) didn't like acronyms too. Here is what his email about acronyms to the [SpaceX](https://en.wikipedia.org/wiki/SpaceX) team allegedly looked like: [ASS (Acronyms Seriously Suck)](https://gist.github.com/klaaspieter/12cd68f54bb71a3940eae5cdd4ea1764).
  * OK: SQL or CSS.
  * Not OK: BDD (Behavior-Driven Development)

6\. Simplicity

* Use the language and structure that is as simple as possible, [but not simpler](https://en.wikiquote.org/wiki/Albert_Einstein).


---

# Agent Instructions: 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:

```
GET https://docs.outtalent.com/guides/writing.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.