In gitlab-org&9429+ we are building an achievement system in GitLab. All planning for now didn't include a plan on how to include documentation for it. This issue is for communicating with the ~"Technical Writing" team, plan the documentation required for this feature and when to include the documentation. /cc @leetickett-gitlab can you add this issue to the epic? \ /cc @lciutacu as the TW for ~"group::organization" ## Checklist - [x] Create a docu outline: [proposal](#proposal). - [x] Create a doc page: !115691+ - [x] Add the new page to the left nav: https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/3712+ ## Proposal [Proposal](https://gitlab.com/gitlab-org/gitlab/-/issues/388390#note_1323748378) for an initial documentation outline: * **GitLab achievements**: - An introductory paragraph about what achievements are (definition), what they look like (consist of a name, a description, and an avatar/image), why they are interesting or valuable to users, why users might want to collect them. - Topic type: [concept](https://docs.gitlab.com/ee/development/documentation/topic_types/concept.html) * **Types of achievements**: - A list of available achievements and what they represent. Here we could also differentiate between "achievements that are earned live forever (for example... 1st merged mr) vs those which are only valid for a period of time (for example... leading organization)". - Topic type: [concept](https://docs.gitlab.com/ee/development/documentation/topic_types/concept.html) or [reference](https://docs.gitlab.com/ee/development/documentation/topic_types/reference.html) * **Gaining/Awarding achievements**: - How achievements are awarded, whether an achievement can be awarded multiple times. - Topic type: [concept](https://docs.gitlab.com/ee/development/documentation/topic_types/concept.html) * **Revoking achievements**: - Why, when, how an achievement can be revoked. - Topic type: [concept](https://docs.gitlab.com/ee/development/documentation/topic_types/concept.html) * **View achievements**: - How to view them on the user profile, where they are located. - Topic type: [task](https://docs.gitlab.com/ee/development/documentation/topic_types/task.html) * **Share achievements**: - How to get a "shareable embed code for each or all user achievements". - Topic type: [task](https://docs.gitlab.com/ee/development/documentation/topic_types/task.html) * **Retrieve a user's achievements**: - How to use the API to get a list of achievements. - Topic type: [task](https://docs.gitlab.com/ee/development/documentation/topic_types/task.html)