Procedure

Procedural topics describe the steps on how to accomplish a task that users follow to produce an intended outcome.

Title Copied

Use action words at the beginning as much as possible.

# Creating Pull Request

Overview Copied

Keep it short, simple, and straightforward. It should also answer the following questions:

## Overview
This guide explains how to create a pull requests. You may create pull request to suggest and collaborate on changes to a repository before you merge the changes into the project.

Prerequisite (optional) Copied

Answers the question, “Is there anything I need to do before I perform this task?

## Prerequisites:

Optional: Include introductory phrase

 - Prerequisite 1
 - Prerequisite 2
 - Prerequisite 3

Procedure Copied

The procedure section is where you describe what the user needs to do. Use an ordered list structure to document this.

For simple procedure, follow this structure:

## Procedure

1. Write the step here. Start with an action word.

- Optional: Include screenshots. See 
- Optional: Insert notes, tips or warnings to highlight any important information that users must know about. See
- Optional: Include code sample. See

2. Write the step here. Start with an action word.

- Optional: Include screenshots. See 
- Optional: Insert notes, tips or warnings to highlight any important information that users must know about. See
- Optional: Include code sample. See

For complex procedure, you can further divide the procedure into subsection for more clarity.

## Procedure
### Subsection 1

 Optional: Provide an introductory phrase if necessary. 

1. Write the step here. Start with an action word.

 - Optional: Include screenshots
 - Optional: Insert notes, tips or warnings to highlight any important information that users must know about.
 - Optional: Include code sample

2. Write the step here. Start with an action word.

 - Optional: Include screenshots
 - Optional: Insert notes, tips or warnings to highlight any important information that users must know about.
 - Optional: Include code sample

### Subsection 2

Optional: Provide an introductory phrase if necessary. 

1. Write the step here. Start with an action word.

 - Optional: Include screenshots
 - Optional: Insert notes, tips or warnings to highlight any important information that users must know about.
 - Optional: Include code sample

2. Write the step here. Start with an action word.

 - Optional: Include screenshots
 - Optional: Insert notes, tips or warnings to highlight any important information that users must know about.
 - Optional: Include code sample

Results (optional) Copied

You may provide the expected result of the procedure.

## Results

Optional: Include screenshot. See

Provide links to related documents.

## Related Resources

For more information, see related articles:
- Link 1
- Link 2
- Link 3

Contact us Copied

Provide a link to contact the Support Team.

## Contact us
If the issue persists, reach out to us by:
- Submitting a ticket through our [Support portal](shttps://support.itrsgroup.com/hc/en-us/requests/new)
- Using the chat service box available across our website.
["Geneos"] ["Geneos > Gateway"] ["User Guide"]

Was this topic helpful?