Skip to content

Commit 2394f3b

Browse files
committed
Update CONTRIBUTING with Foreman user personas
1 parent 292e21e commit 2394f3b

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,26 @@ We do not capitalize the following terms:
220220
* remote execution
221221
* subscription
222222

223+
### Foreman user personas
224+
225+
In documentation, a user persona is the target user who will be reading the documentation.
226+
Understanding and identifying the target persona of a piece of content helps ensure that the documentation will properly address the user's needs and capabilities.
227+
228+
Foreman users include people with varying responsibilities and permissions.
229+
Especially in larger organizations, different tasks can be performed by different people.
230+
Therefore, when contributing to Foreman documentation, it can be useful to be aware of and distinguish Foreman user personas.
231+
232+
#### *User* persona
233+
234+
* Has limited permissions
235+
* Runs regular Foreman operations
236+
* Example responsibilities: managing hosts, managing content
237+
238+
#### *Admin* persona
239+
240+
* Has unlimited permissions, including root on the server
241+
* Example responsibilities: managing Foreman server
242+
223243
### Further Information
224244

225245
* [Contributing Guidelines for Github documentation](https://github.com/github/docs/blob/main/CONTRIBUTING.md)

0 commit comments

Comments
 (0)