Skip to content

Commit 5175055

Browse files
committed
Standardize documentation to impersonal voice
1 parent 75174ba commit 5175055

55 files changed

Lines changed: 264 additions & 265 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎v1.6/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ home: true
33
title: CaSS Competency and Skills System
44
heroImage: /cass-logo.png
55
heroText: Competency and Skills System
6-
tagline: A collaborative interface for managing your competency frameworks.
6+
tagline: An open-source platform for competency framework management.
77
actionText: Get Started →
88
actionLink: /guide/introduction/
99
footer: Copyright © 2024 Eduworks Corporation
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Assertion Timeline
22

3-
**Assertion Timeline is only available to logged in users, ensure you are logged in to the application before continuing.**
3+
**Assertion Timeline is only available to logged in users, ensure it is logged in to the application before continuing.**
44

55
To access the Assertion Timeline, click the button indicated below in the left navigation bar.
66

77
![Open Assertion Timeline](/v1.5/authoring/assertion-timeline-button.png)
88

9-
The timeline will display any assertions made by you, about you, or that have been shared with you.
9+
The timeline will display any assertions made by the user, about the user, or that have been shared with the user.
1010

1111
![Assertion Timeline](/v1.5/authoring/assertion-timeline.png)
1212

13-
You can click on any competency mentioned in the timeline to open the related framework.
13+
The system allows click on any competency mentioned in the timeline to open the related framework.
1414

1515
![Deleting Assertions](/v1.5/authoring/assertion-timeline-delete.png)
1616

17-
You can also delete any assertions you've made directly from the assertion timeline.
17+
The system allows also delete any assertions have been made directly from the assertion timeline.

‎v1.6/authoring/assertions/managing-assertions/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Creating and Editing
22

3-
**Assertion management is only available to logged in users, ensure you are logged in to the application before continuing.**
3+
**Assertion management is only available to logged in users, ensure it is logged in to the application before continuing.**
44

55
## Enabling Assertion Management
66

7-
Open any framework and you should be presented with a *manage assertions* button in the top toolbar
7+
Open any framework and the user should be presented with a *manage assertions* button in the top toolbar
88

99
![Manage Assertions Button](/v1.5/authoring/manage-assertions-button.png)
1010

@@ -14,7 +14,7 @@ To return to the framework editing mode, simply press the *stop managing asserti
1414

1515
## Choosing a Subject
1616

17-
You can choose to make assertions about yourself, or another user in the system. In order to change the subject of your assertions, click the *myself* button and select a new user from the resulting dialog.
17+
The system allows choose to make assertions about yourself, or another user in the system. In order to change the subject of the assertions, click the *myself* button and select a new user from the resulting dialog.
1818

1919
![Select Assertion Subject Button](/v1.5/authoring/select-assertion-subject-button.png)
2020

@@ -24,7 +24,7 @@ Once in the assertion management mode, the competencies in the framework will di
2424

2525
![Assertion Editor Controls](/v1.5/authoring/assertion-editor-controls.png)
2626

27-
Clicking the *I can* button will generate a positive assertion for that competency and display an input field allowing you to provide evidence in the form of text or a link to support the assertion. Press *enter* on your keyboard after entering the evidence into the input field to attach it to your assertion.
27+
Clicking the *I can* button will generate a positive assertion for that competency and display an input field allowing the user to provide evidence in the form of text or a link to support the assertion. Press *enter* on the keyboard after entering the evidence into the input field to attach it to the assertion.
2828

2929
![Assertion Editor Add Evidence](/v1.5/authoring/assertion-editor-add-evidence.png)
3030

@@ -40,7 +40,7 @@ To delete an assertion, simply click the same button that was used to create the
4040

4141
## Adding a Badge
4242

43-
You can add a badge to a positive assertion by clicking the *add badge* button.
43+
additions can be made a badge to a positive assertion by clicking the *add badge* button.
4444

4545
![Assertion Editor Add Badge](/v1.5/authoring/assertion-editor-add-badge.png)
4646

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Sharing Assertions
22

3-
**Sharing assertions is only available to logged in users, ensure you are logged in to the application before continuing.**
3+
**Sharing assertions is only available to logged in users, ensure it is logged in to the application before continuing.**
44

55
To share assertions, click the button indicated below in the left navigation bar.
66

77
![Assertion Share Button](/v1.5/authoring/assertion-share-button.png)
88

9-
In the resulting dialog, select the subject(s) of the assertions and the user(s) whom you wish to share those assertion with, and then press the share button.
9+
In the resulting dialog, select the subject(s) of the assertions and the user(s) whom the user wish to share those assertion with, and then press the share button.
1010

1111
![Assertion Share Dialog](/v1.5/authoring/assertion-share-dialog.png)

‎v1.6/authoring/competency-and-framework-management/README.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
# Finding and Editing
1+
# Finding and Editing
22

33
Competency frameworks can be viewed and managed in CaSS Authoring Tools by navigating to the ***Frameworks*** page. The Frameworks page can be visited by clicking on the ***Frameworks*** button on the left sidebar highlighted by the red box in the image below.
44

55
![CAT Competency Framework Management - Frameworks Page](/v1.5/authoring/frameworks-page.png)
66

77
On this page, frameworks are shown with their names in bold. Beneath the
8-
name, you can see how many competencies are in the framework, when it
9-
was created and last modified. If you have permission to edit the
8+
name, The system allows see how many competencies are in the framework, when it
9+
was created and last modified. If the user have permission to edit the
1010
framework, it will say “*Editable*”.
1111

1212
## Sorting and Filtering Frameworks
1313

14-
You can sort and filter the list of frameworks by clicking the filter
14+
the list can be sorted and filtered of frameworks by clicking the filter
1515
button next to the search bar. The button next to it clears any filters
16-
you’ve applied.
16+
has been applied.
1717

1818
![CAT Competency Framework Management - Filter Button](/v1.5/authoring/filter-frameworks-button.png)
1919

2020

2121
The filter button will open up a side panel to the right of the
22-
framework list with options to sort, filter, and apply your search term
22+
framework list with options to sort, filter, and apply the search term
2323
to various fields.
2424

2525
![CAT Competency and Framework Management - Filter and Sort Panel](/v1.5/authoring/filter-and-sort-panel.png)
@@ -54,55 +54,55 @@ A new competency framework can be created within CaSS Authoring Tools by pressin
5454

5555
![CAT Competency Framework Management - Create New Framework](/v1.5/authoring/create-new-framework.png)
5656

57-
When you click on the ***Create New*** button to create a new competency framework, you will be required to enter a *Framework Name* and *Framework description* to your new competency framework. Additional properties can be added to a competency framework that are controlled by CaSS Authoring Tools’ configuration settings. For more information about configuration settings and managing the properties of competency frameworks, see the ***Custom Framework Properties*** section of this user guide under ***Competency Framework and Competency Configuration***.
57+
When the user click on the ***Create New*** button to create a new competency framework, the system will be required to enter a *Framework Name* and *Framework description* to the new competency framework. Additional properties can be added to a competency framework that are controlled by CaSS Authoring Tools’ configuration settings. For more information about configuration settings and managing the properties of competency frameworks, see the ***Custom Framework Properties*** section of this user guide under ***Competency Framework and Competency Configuration***.
5858

5959
## Adding Competencies
6060

61-
To add competencies to your framework, click the ***add competency*** button below the framework details.
61+
To add competencies to the framework, click the ***add competency*** button below the framework details.
6262

6363
![CAT Competency Framework Management - Add Competencies](/v1.5/authoring/add-competencies.png)
6464

65-
You can construct a hierarchy of competencies by checking the box to the left of a competency. The ***add competency*** button text will change to ***add child***, which you can click to place a competency underneath the one you’ve checked.
65+
A hierarchy can be constructed of competencies by checking the box to the left of a competency. The ***add competency*** button text will change to ***add child***, which The system allows click to place a competency underneath the one has been checked.
6666

6767
![CAT Competency Framework Management - Add Children to Competencies](/v1.5/authoring/add-children-competencies.png)
6868

6969
## Editing Frameworks and Competencies
7070

71-
To edit a single competency or framework, hover over the item you want to edit and an edit icon will appear. Click the icon highlighted in red in the image below.
71+
To edit a single competency or framework, hover over the item the user want to edit and an edit icon will appear. Click the icon highlighted in red in the image below.
7272

7373
![CAT Competency Framework Management - Edit](/v1.5/authoring/edit-competencies.png)
7474

75-
A modal will appear and you can edit the framework or competency’s properties. This modal also allows you to delete the competency or framework, remove a competency from the current framework without deleting it, and export the object. Click ***done*** when you’ve finished making changes.
75+
A modal will appear and the properties can be edited for the framework or competency’s properties. This modal also allows the user to delete the competency or framework, remove a competency from the current framework without deleting it, and export the object. Click ***done*** when has been finished making changes.
7676

7777
![CAT Competency Framework Management - Edit Modal](/v1.5/authoring/edit-modal.png)
7878

79-
You can add new properties to your object from here too by clicking the ***add property*** button at the bottom of the modal. You’ll see a list of properties that are available to add, determined by the configuration you’re using. Select the property you’d like to add, enter in the value, and click ***save property***.
79+
new properties can be added to the object from here too by clicking the ***add property*** button at the bottom of the modal. the interface will see a list of properties that are available to add, determined by the configuration is using. Select the property is intended to add, enter in the value, and click ***save property***.
8080

8181
![CAT Competency Framework Management - Add a Property](/v1.5/authoring/add-property.png)
8282

83-
If there’s a property you’d like to add to multiple competencies, use the checkboxes to select the competencies you want to edit and click ***edit multiple***.
83+
If to add a property is intended to add to multiple competencies, use the checkboxes to select the competencies the user want to edit and click ***edit multiple***.
8484

8585
![CAT Competency Framework Management - Edit Multiple Competencies](/v1.5/authoring/edit-multiple-competencies.png)
8686

87-
You’ll see a list of properties that are available to add, determined by the configuration you’re using. Select the property you’d like to add, enter the value, and click ***apply to multiple***.
87+
the interface will see a list of properties that are available to add, determined by the configuration is using. Select the property is intended to add, enter the value, and click ***apply to multiple***.
8888

8989
![CAT Competency Framework Management - Adding Property to Multiple Competencies](/v1.5/authoring/adding-property-to-multiple.png)
9090

91-
If you make a mistake while editing, click the ***undo*** button in the bar at the top of the page to revert your most recent changes.
91+
If the user make a mistake while editing, click the ***undo*** button in the bar at the top of the page to revert the most recent changes.
9292

9393
![CAT Competency Framework Management - Undo Button](/v1.5/authoring/undo-button.png)
9494

9595
### Changing Competency Hierarchy
9696

97-
There are several ways to move competencies around in the hierarchy. You can drag and drop the competency to the spot you’d like to move it to by hovering over the competency. The icon highlighted in the image below will appear and you can click on it, hold down, and drag the competency to the appropriate position.
97+
There are several ways to move competencies around in the hierarchy. drag-and-drop is supported for the competency to the spot is intended to move it to by hovering over the competency. The icon highlighted in the image below will appear and The system allows click on it, hold down, and drag the competency to the appropriate position.
9898

9999
![CAT Competency Framework Management - Drag and Drop](/v1.5/authoring/drag-and-drop.png)
100100

101-
You can also move a competency by selecting its checkbox. Click the cut or copy icon highlighted in red in the image below, select another competency, and click the paste icon.
101+
The system allows also move a competency by selecting its checkbox. Click the cut or copy icon highlighted in red in the image below, select another competency, and click the paste icon.
102102

103103
![CAT Competency Framework Management - Cut, Copy, Paste](/v1.5/authoring/cut-copy-paste.png)
104104

105-
With one competency selected, you can move it with keyboard commands as well. You can cut, copy and paste, or use the arrow keys to move it to the position you want.
105+
With one competency selected, The system allows move it with keyboard commands as well. The system allows cut, copy and paste, or use the arrow keys to move it to the position the user want.
106106
- **Tab** - Switch focus between elements on the page
107107
- **Space** - Select the element currently in focus
108108
- **Shift + X** - Cut competency
@@ -113,22 +113,22 @@ With one competency selected, you can move it with keyboard commands as well. Yo
113113

114114
## Setting a Configuration
115115

116-
Configurations control which properties you can edit and display within a particular framework, and what types of values they can have. If youdon’t specify a configuration for your framework, the browser, instance, or CaSS default will control the properties. If you want a framework to have a different configuration, you can set one by clicking the
116+
Configurations control which properties the properties can be edited for and display within a particular framework, and what types of values they can have. If youdon’t specify a configuration for the framework, the browser, instance, or CaSS default will control the properties. If the user want a framework to have a different configuration, The system allows set one by clicking the
117117
framework configuration button.
118118

119119
![CAT Competency Framework Management - Setting a Framework Configuration](/v1.5/authoring/setting-a-framework-configuration.png)
120120

121-
This will open up a panel with a list of available configurations to apply. Click ***set as framework default*** next to the configuration you want.
121+
This will open up a panel with a list of available configurations to apply. Click ***set as framework default*** next to the configuration the user want.
122122

123123
![CAT Competency Framework Management - Manage Framework Configuration](/v1.5/authoring/manage-framework-configuration.png)
124124

125125
## Managing Users and Sharing a Framework
126126

127-
To control who can view and edit a framework you own, click the ***manage users*** button highlighted in red in the image below.
127+
To control who can view and edit a framework the user own, click the ***manage users*** button highlighted in red in the image below.
128128

129129
![CAT Competency Framework Management - Manage Users Button](/v1.5/authoring/manage-users-button.png)
130130

131-
You can see who the admins and viewers of your framework are, and add or remove users and organizations. This view also has a shareable link to your framework that you can copy to your clipboard and give to someone else.
131+
The system allows see who the admins and viewers of the framework are, and add or remove users and organizations. This view also has a shareable link to the framework that The system allows copy to the clipboard and give to someone else.
132132

133133
![CAT Competency Framework Management - Share Framework and Manage Users](/v1.5/authoring/share-framework-and-manage-users.png)
134134

0 commit comments

Comments
 (0)