Skip to content

Commit d65fe73

Browse files
authored
Adding new section Information required
1 parent 0a7250c commit d65fe73

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

general/development/process/release/docsrequiredissues.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,35 @@ tags:
66
- Processes
77
---
88

9-
## Issue labelling
9+
## Information required
1010

11-
Prior to each major release, add labels to closed issues as follows:
11+
Issue descriptions should include enough details to document the new feature or improvement, ideally answering the following questions:
12+
13+
- What problem does this feature solve?
14+
- What is the goal of the user?
15+
- Who is the target audience (e.g. admins, teachers)?
16+
- How does the feature work from a user’s perspective? What are the steps?
17+
- Are there any dependencies / other features that this new feature relies on?
18+
- Does the user interface change for existing users?
19+
- Are there any differences in an upgraded site versus a new install?
20+
- Is there anything a site administrator should know about before upgrading their site?
21+
- Are error messages possible, and if so, how can each error be resolved?
22+
23+
## Identifying issues
24+
25+
A list of key features and improvements in the new version should be created for providing content for [New features](https://docs.moodle.org/en/New_features).
26+
27+
Issues should be labelled as follows:
1228

1329
- `docs_required` - new features and improvements which need documenting, also changes which require the existing documentation to be updated.
1430
- `ui_change` - significant changes to the student or teacher user interface.
1531
- `upgrade_notes` - issues that may affect upgraded sites such as new site admin settings, user tours, major UI changes.
1632

17-
## Writing documentation
33+
## Adding documentation
1834

19-
1. Go through the list of [closed MDL docs_required-labelled issues](https://moodle.atlassian.net/issues/?jql=project%20%3D%20MDL%20AND%20status%20%3D%20Closed%20AND%20labels%20%3D%20docs_required) and write documentation based on the issue description or testing instructions. If it's unclear, comment in the issue asking for help.
20-
2. Go through the list of ui_change-labelled issues for the version e.g. [ui_change-labelled issues with 4.3 fix version](https://moodle.atlassian.net/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.3%20AND%20labels%20%3D%20ui_change) and update existing documentation including screenshots.
21-
3. Go through the list of upgrade_notes-labelled issues for the version e.g. [upgrade_notes-labelled issues with 4.3 fix version](https://moodle.atlassian.net/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%204.3%20AND%20labels%20%3D%20upgrade_notes) and add documentation to the docs page [Upgrading](https://docs.moodle.org/en/Upgrading) under 'Possible issues that may affect you in Moodle x'.
35+
1. Go through the list of [closed MDL docs_required-labelled issues](https://moodle.atlassian.net/issues/?jql=project%20%3D%20MDL%20AND%20status%20%3D%20Closed%20AND%20labels%20%3D%20docs_required) and add documentation to the appropriate place in the user documentation.
36+
2. Go through the list of ui_change-labelled issues for the version e.g. [ui_change-labelled issues with 5.1 fix version](https://moodle.atlassian.net/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%205.1%20AND%20labels%20%3D%20ui_change) and update existing documentation including screenshots.
37+
3. Go through the list of upgrade_notes-labelled issues for the version e.g. [upgrade_notes-labelled issues with 5.1 fix version](https://moodle.atlassian.net/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%205.1%20AND%20labels%20%3D%20upgrade_notes) and add documentation to the docs page [Upgrading](https://docs.moodle.org/en/Upgrading) under 'Possible issues that may affect you in Moodle x'.
2238
4. When saving the documentation wiki edit, mention the tracker issue number in the edit summary.
2339
5. For a new feature or improvement with at least a paragraph of documentation, edit the tracker issue and add the documentation link. For an existing documentation update, there is no need to add a documentation link.
2440
6. Optional: Add a comment to the tracker issue with the documentation link.

0 commit comments

Comments
 (0)