Skip to content
This repository was archived by the owner on Sep 24, 2022. It is now read-only.
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions code-of-conduct/guide-code-of-conduct-incident-record.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# Code of Conduct incident record template guide

---
Thank you for downloading the Code of Conduct template from The Good Docs Project!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder about the use of the word "downloading" 😁 I guess that is something for Content Strategy group to address. It could be that they copy or fork. We could change to "using" rather than "downloading".

We welcome any kind of feedback on our templates, both positive and negative.
To suggest improvements, open an issue on our (https://github.com/thegooddocsproject/templates/issues)[Templates repository].

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To suggest improvements, open an issue on our (https://github.com/thegooddocsproject/templates/issues)[Templates repository].
To suggest improvements, open an issue on our [Templates repository](https://github.com/thegooddocsproject/templates/issues).

---

This is the guide that explains how to use the Good Docs Project Code of Conduct incident record template, which is part of the Code of Conduct template set.

The Code of Conduct template set includes:

- A `template-code-of-conduct.md` file that you can use to create your community's public-facing Code of Conduct.
- A `template-code-of-conduct-response-plan.md` file that you can use to create and explain the response policy and procedures your team will follow as you handle Code of Conduct incidents. This template is included in the same folder as the Code of Conduct template.
- A `template-code-of-conduct-incident-record.md` file for a form that is filled out when a community moderator takes an incident report from a community members. This template is included in the same folder as the Code of Conduct template.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- A `template-code-of-conduct-incident-record.md` file for a form that is filled out when a community moderator takes an incident report from a community members. This template is included in the same folder as the Code of Conduct template.
- A `template-code-of-conduct-incident-record.md` file for a form that is filled out when a community moderator takes an incident report from a community member. This template is included in the same folder as the Code of Conduct template.

- A `template-code-of-conduct-remediation-record.md` file for a form that is filled out when a community moderator meets with a community member to explain the consequences of a Code of Conduct violation. This template is included in the same folder as the Code of Conduct template.
- The following guides:
- `guide-code-of-conduct.md`
- `guide-code-of-conduct-response-plan.md`
- `guide-code-of-conduct-incident-record.md`
- `guide-code-of-conduct-remediation-record`

You might also consider using the `../our-team/template-our-team.md` template to let your community members know who they can contact to report a Code of Conduct violation. This document is not only necessary for Code of Conduct violations. It is a core document that helps you clearly communicate who belongs to your open source project or organization.


## Why do I need a Code of Conduct incident record?

See the `guide-code-of-conduct.md` for reasons to incorporate a Code of Conduct and response plan.

The Code of Conduct incident record is part of the documentation that needs to be kept when investigating and resolving Code of Conduct incidents.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Query on the word "kept" - do we mean "stored/saved", or do we mean, "generated" ?

It is important to file this documentation to enable the community moderators to identify and prevent potential repeated patterns of abuse in the community.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It is important to file this documentation to enable the community moderators to identify and prevent potential repeated patterns of abuse in the community.
It is important to file this documentation to enable the community moderators to identify and prevent potential patterns of abuse in the community.

"repeated patterns" is tautological.
query: The word "file" in this sentence is ambiguous. At first I read it as "record and store". But I think we actually mean to "act upon" or "do something about", "raise".



## Content of the Code of Conduct incident record template

The following sections provide guidance about how to fill out each section of the Code of Conduct incident record template.

:information_source: The Code of Conduct incident record template includes boilerplate text that you can customize or adapt, use as-is, or completely replace with your own text.


### About the "Introduction" section
The *Introduction* section includes a description of the goals the community moderator should keep in mind while taking an incident report from an individual.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not actually called the "Introduction" section in the document. I got a bit confused. Is it missing a heading? or is it called 'Tips for the community moderator' ? I'm not sure.

The community moderator should refer to this section regularly to ensure that the incident reporter feels safe and supported throughout the process.


### About the "Incident number" section

Follow your organization's incident number protocol in assigning an incident number.

The incident number can include the date an investigation was opened.
For example, yyyy-001.


### About the "Name of community moderator who took the report" section

The community moderator who took the report lists their name here.


Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### About the "Name of incident reporter" section

Missing section? I know it's just the name - do we include every section?

### About the "Reporter's contact information" section

This section is optional.
If the reporter is comfortable giving their name and contact information, note that information here.


### About the "Permission from incident reporter to proceed?" section

Ask the incident reporter for permission to proceeed.
Indicate their response in thise section.

If an incident reporter does not give permission to proceed with an investigation, they will be given the option to hold the report “in escrow.”
Escrowed reports will not be acted upon until there is a second report of the same incident or a similar incident involving the same individual.
The goal of an escrow report is to retain a record of incidents in case there is a pattern of misbehavior by the same individual.

If the reporter wishes to keep the report in escrow, the incident record should still be filled out and filed in the appropriate archives for future tracking.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If the reporter wishes to keep the report in escrow, the incident record should still be filled out and filed in the appropriate archives for future tracking.
If the reporter wants to keep the report in escrow, the incident record should still be filled out and filed in the appropriate archives for future tracking.

suggestion: change wishes to wants. Subjective - I will raise as a style guide decision.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adopted.



### About the "Date, time, and location of incident" section

This section is optional. Indicate the date, time, or location of the incident if known.


### About the "Additional witnesses or contacts" section

If the incident reporter mentions that other individuals were involved or present as witnesses, list those individuals here.
If possible, note their contact information.


### About the "Incident description" section

After listening to the incident reporter's description of the incident, write the details here.

As indicated on the template, remember to only document information required to inform the report resolution.
Where possible, avoid documenting your opinion about the incident, or any information about individuals that is not relevant to the report.


## Additional resources

In creating this form, the authors were inspired by the [Otter Tech Code of Conduct Enforcement Training](https://otter.technology/code-of-conduct-training/).
104 changes: 104 additions & 0 deletions code-of-conduct/guide-code-of-conduct-remediation-record.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Code of Conduct remediation record template guide

---
Thank you for downloading the Code of Conduct template from The Good Docs Project!
We welcome any kind of feedback on our templates, both positive and negative.
To suggest improvements, open an issue on our (https://github.com/thegooddocsproject/templates/issues)[Templates repository].

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To suggest improvements, open an issue on our (https://github.com/thegooddocsproject/templates/issues)[Templates repository].
To suggest improvements, open an issue on our [Templates repository](https://github.com/thegooddocsproject/templates/issues).

---

This is the guide that explains how to use the Good Docs Project Code of Conduct remediation record template, which is part of the Code of Conduct template set.

The Code of Conduct template set includes:

- A `template-code-of-conduct.md` file that you can use to create your community's public-facing Code of Conduct.
- A `template-code-of-conduct-response-plan.md` file that you can use to create and explain the response policy and procedures your team will follow as you handle Code of Conduct incidents. This template is included in the same folder as the Code of Conduct template.
- A `template-code-of-conduct-incident-record.md` file for a form that is filled out when a community moderator takes an incident report from a community members. This template is included in the same folder as the Code of Conduct template.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- A `template-code-of-conduct-incident-record.md` file for a form that is filled out when a community moderator takes an incident report from a community members. This template is included in the same folder as the Code of Conduct template.
- A `template-code-of-conduct-incident-record.md` file for a form that is filled out when a community moderator takes an incident report from a community member. This template is included in the same folder as the Code of Conduct template.

- A `template-code-of-conduct-remediation-record.md` file for a form that is filled out when a community moderator meets with a community member to explain the consequences of a Code of Conduct violation. This template is included in the same folder as the Code of Conduct template.
- The following guides:
- `guide-code-of-conduct.md`
- `guide-code-of-conduct-response-plan.md`
- `guide-code-of-conduct-incident-record.md`
- `guide-code-of-conduct-remediation-record`

You might also consider using the `../our-team/template-our-team.md` template to let your community members know who they can contact to report a Code of Conduct violation. This document is not only necessary for Code of Conduct violations. It is a core document that helps you clearly communicate who belongs to your open source project or organization.


## Why do I need a Code of Conduct remediation record?

See the `guide-code-of-conduct.md` for reasons to incorporate a Code of Conduct and response plan.

The Code of Conduct remediation record is part of the documentation that needs to be kept when investigating and resolving Code of Conduct incidents.
It is important to file this documentation to enable the community moderators to identify and prevent potential repeated patterns of abuse in the community.
Comment on lines +30 to +

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comments on the incident record guide for this section.



## Content of the Code of Conduct remediation record template

The following sections provide guidance about how to fill out each section of the Code of Conduct remediation record template.

:information_source: The Code of Conduct remediation record template includes boilerplate text that you can customize or adapt, use as-is, or completely replace with your own text.


### About the "Introduction" section

The *Introduction* section includes a description of the goals the community moderator should keep in mind while taking an incident report from an individual.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not named the "Introduction" section in the document. Perhaps the header is missing?
Also, I was confused because it says "Tips" - but this explanation says the reader should refer to it regularly. I wonder if removing the phrase "Tips for the community moderator" would address that confusion. It is more like guidance. "Tips" feel like something I can ignore.

The community moderator should refer to this section regularly to ensure that they stay focused on the goal of explaining the outcome of the Code of Conduct violation.
These meetings have the potential to be stressful and full of high emotions.
The introduction section provides some guidelines from keeping these meetings under control.


### About the "Incident number" section

The incident number should match the same incident number assigned on the [Code of Conduct incident record](template-code-of-conduct-incident-record.md) for this incident.


### About the "Name of community moderator who remediated the incident" section

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Query: Is the word "remediated" correct to use in this context? It implies resolution which feels like something that happens at the end, rather than something being raised, or in process. Heard? Took receipt of? Facilitated? I don't think any of these are right either. Just wanted to ask the question.


List the name of the community moderator who remediated the incident here.


### About the "Name of community member involved in the incident" section

List the name of the individual who committed the Code of Conduct violation here.


Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing explainers for the Severity level and Impact level sections. Were they omitted on purpose? As a reader, I would have liked a description about what high, medium, and low means.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aah! I see now they live in the Response plan document. Perhaps we could add a pointer here to them.

### About the "Outcome" section

Indicate the outcome of the Code of Conduct violation, as discussed with the other community moderators.


### About the "Behavior modification plan" section

Indicate the steps that will be taken as part of the outcome of the Code of Conduct violation.
For example, if the outcome is a temporary ban from the community, indicate what steps will be taken to remove the individual's access to community forums, repositories, etc.


### About the "Do you agree to follow the plan?" section

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the template, I suggested a different title.


After explaining the behavior modification plan, the community moderator should ask directly whether the individual will agree to follow the plan and note their response here.


### About the "Consequences if they do not agree to the behavior modification plan" section

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the template, I suggested a different title.


In this section, list the consequences for failing to agree to the behavior modification plan.
The suggested consequence is removal from the community.


### About the "Who can they appeal this decision to?" section

Fill out the details for appealing a decision in this form.
If the appeals process doesn't change, simply add that to this form from the start for all incidents.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.



### About the "Reported person's response to the plan" section

Record the details of how the reported person responded to the plan here.


### About the "Additional information gathered" section

If any additional information needed, it can be noted here.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If any additional information needed, it can be noted here.
If any additional information is needed, note it here.



## Additional resources

In creating this form, the authors were inspired by the [Otter Tech Code of Conduct Enforcement Training](https://otter.technology/code-of-conduct-training/).
Loading