Skip to content

Commit 38d5b24

Browse files
committed
Update CONTRIBUTING with Foreman user personas
1 parent c0b3e8f commit 38d5b24

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
@@ -221,6 +221,26 @@ We do not capitalize the following terms:
221221
* remote execution
222222
* subscription
223223

224+
### Foreman user personas
225+
226+
In documentation, a user persona is the target user who will be reading the documentation.
227+
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.
228+
229+
Foreman users include people with varying responsibilities and permissions.
230+
Especially in larger organizations, different tasks can be performed by different people.
231+
Therefore, when contributing to Foreman documentation, it can be useful to be aware of and distinguish Foreman user personas.
232+
233+
#### *User* persona
234+
235+
* Has limited permissions
236+
* Runs regular Foreman operations
237+
* Example responsibilities: managing hosts, managing content
238+
239+
#### *Admin* persona
240+
241+
* Has unlimited permissions, including root on the server
242+
* Example responsibilities: managing Foreman server
243+
224244
### Further Information
225245

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

0 commit comments

Comments
 (0)