Review these guidelines before you begin authoring content.
These are general best practices for writing content:
Follow these guidelines when organizing your documentation:
-), not asterisks (*), for bullets. Ensure all list items end with a period if even one item contains more than three words.create-new-user.md and create-user-step-1.jpg).<br> tag to force line breaks.<ul>/<ol> and <li> tags to create bulleted and numbered lists within Markdown tables.Follow these best practices when writing with Markdown.
| Use | Don't Use |
| Click Generate report. | Click on Generate report. |
| Click Migrate. | Click the migrate button. |
| Select the Reports tab. | Click on the Reports tab. |
*) for italics. Don't use underscores (_).THIS_CODE_PHRASE).#) and then change sequentially; don't jump from an H2 (##) to an H4 (####).#) per page. Follow your H1 with an introductory paragraph that explains the topic.#).| Use | Don't Use |
| Create a user | How to create a user |
| Migrate to AWS | AWS migration |
| Workflow architecture | Understanding the workflow architecture |
| Environments | List of environments |
```php
public function __construct() {
$this->user = new User();
}
```
`line_of_code`| Use | Don't Use |
`[Google](https://google.com)` |
[Click here](https://google.com) |
`<https://google.com>` |
https://google.com |
Ensure every page has an introductory sentence for *each* heading on the page. You can't have the title of the document, then an H2, for example.
Ensure every page has a More info section (or a Next step section for getting started topics) at the end that containing at least two relevant links.
Follow these best writing practices to ensure your content is clear and concise: