Overview
Unmet needs
Currently, the king Portal’s user documentation is spread all across and there is no central point to access the information.
The presence of documentation helps users to understand how the product functions and it helps keep track of all aspects of an application. The main focuses are development, maintenance, and knowledge transfer to other developers.
Objectives
The main objective is to gather information from the experts who are familiar with the portal features and use the features correctly.
Jobs we want to cover
When is the main purpose of the feature?
Who can access the feature?
How to use the feature correctly?
What are the current functionalities and how and when do you use them?
Who do you ask if you have issues using the functionalities?
How do you raise the ticket for technical support?
Who do you assign the ticket to for helpdesk or technical support?
Constraints
Currently, there are no known issues that might affect the documentation flow.
Explorations + Decisions
The documentation is a part of ‘The Portal Documentation project. The documentation will cover the User Guide section discussed in https://kingliving.atlassian.net/browse/EP-1210
Once we achieve the proper documentation for each section, the link will be established between the portal and the documentation.
Releases
Not released. Ignore the section for now.
Release Name | Value it adds | Scope | Status | Completed date |
---|---|---|---|---|
|
|
| To do / In progress / Blocked / Waiting for feedback / Done | Jun 22, 2022 |
Next steps
The next step is to add pages and assign them to the right people to prepare the documentation.