---
title: 'Documentation Template'
date: '10/14/2021'
description: Template for writers to follow for consistency or presentation
priority: 3
---
# Documentation Template for Writers
For an example of an effective use of the template, see [Migrating Data Buckets](https://sensai.a2z.com/docs/Main/Services/Sensai-ModelBuilder/SMB-Migrating-Data-Buckets).
## Document Metadata
When creating a new document:
1. Right click on the appropriate directory and select **New File**.
2. Name the new file. All SMB-specific filenames must start with **SMB**, may not contain spaces, and must be saved as **.md** files.
3. Open an existing document.
4. Copy the metadata block.
5. Paste it into the new document.
6. Edit the details to match your new document.
- Title, description and date are required fields
- Priority (optional) controls how the side navigation is ordered within a directory:
- Priority 1-99 will be organized before directories.
- Priority 101+ will be organized after a directory.
- If no priority is specified or they are equal, the items will be organized by in alphabetical order.
```markdown
---
title: 'Content Template for Writers'
date: '5/26/2021'
description: Template for consistency
priority: 3
---
```
## Headers
```markdown
# H1 - Document headline
## H2 - Section headings
### H3 - Subsection headings within H2 section
#### H4
##### H5
###### H6
```
## Emphasis
```markdown
Italics: For document references and screen names *asterisks* or _underscores_.
Bolding: For button and screen choices within steps **asterisks** or __underscores__.
```
Example: On the *Submit screen* select **Send**. Click **OK**.
## Lists
Numbered list: For sequential steps, or tasks done in order. Complete sentences end in a period.
```markdown
1. First step
2. Another step
* Unordered sub-list
* Unordered sub-list
3. Another step
a. Ordered sub-list
b. Ordered sub-list
4. And another step
```
Bullet list: For non-sequential items or a list. Complete sentences end in a period.
```markdown
* Unordered list can use asterisks
- Or minuses
```
## Notes
To designate a note, use the `` tags. For example:
This is an example note. Notes are helpful hints or tips to help the user understand a process or steps more efficiently. Notes help eliminate confusion.
You can also specify a header prop to override the Note header.
```no highlight
This would replace Note with Example!
```
This would replace Note with Example!
## Images
### Working with images
- Images should be clear and highlight the relevant screen choices. Avoid using entire screen images, if possible.
- Relevant images appear below the step where they are referenced.
- Images include a 3mm black border to prevent the image blending in to the text.
- Image highlights are 3mm orange (hex #F7AC08). Do not use red, blue or green highlights.
- Images are saved in .png format.
- Name images as they appear sequentially in the document, for example, 01-landing-page.png, 02-sagemaker-console.png.
### The image directory
- Images are stored in the online repository on Amazon Drive (https://drive.corp.amazon.com/folders/SensaiDocs%20Resources/services/Sensai%20ModelBuilder).
- Naming convention for image folders is SMB-XX-XX.
### Inserting images
1. Copy the location for an existing image, for example: `https://drive.corp.amazon.com/documents/SensaiDocs%20Resources/services/Sensai%20ModelBuilder/SMB-document-template/01-New-file.png`
2. Insert the image into a document.
3. Add an exclamation point (!).
4. Add the *alt-text* in brackets.
5. Change the copied location from *drive* to *drive-render* and change *documents* to *view*. Do not delete the `%20` spacing indicators.
```markdown
Inline-style:
```
## Code Highlighting
Code blocks are actual lines of code for the user to enter.
```markdown
def _get_train_generator_params(self):
train_generator_params = super()._get_train_generator_params()
```
Inline code examples begin and end with an open single quote. For example: `--output-prefix` or `-p` flag.
## Adding Embedded videos
You can embed videos from Amazon Broadcast links using the typical image pattern or a video component.
Include blank lines above and below videos.
```markdown
```