*Internal App Support Knowledge base system (SKB) code review notes*
Participants: Ruwan, Nandika, Heshan, Nuwan, Srinath, Azeez, Manjula
Presenter: Sarasi
*
Set of features identified to include in system as follows:*
We can add Issues to KB, there, It is good to give following options;
- Extract Solution in addition to Question, Response from jira
- Response contains mainly logs, memory dumps, thread dumps and
even solution as well sometimes.
- Let user to make same statement as Question and Response, for
that use check boxes or option buttons as needed.
- Once the users have selected statements as Question,Response and
Solution and submits, show the all selected questions.. and get user
confirmation rather showing each statement.
- Current system allows user to add solution manually, if no
statement is checked as a solution, then only allow adding a solution
manually.
- Let users to add related,similar links to the current issue.
- Categorize the issues as performance issue, bug fixing and so.
- Customized search for searching customer question, solution
- Use pagination to show searched results
- Extracting data from jira, supporting custom fields as currently
only selected fields are provided.
*Possible improvements in code:*
- Change the resource path in registry to avoid data duplication
from
SupportKB/Issue
SupportKB/solutions
SupportKB/wso2 response
SupportKB/customer questions
to
SupportKB/jiraid/Issue
/solutions
/wso2 response
/customer question
- Change package names from org.wso2.carbon.registry.custom.skb.*
to org.wso2.skb.*
- Change jsp page names from skb_sample.jsp to sample.jsp since the
package name itself is there.
- In exception handling, pass the exception to upper layers, and
handle it at ui with proper error message.
- Introduce constants for kb items used. Here adding QName constant
is useful rather creating each time.
- Use more java doc comments
- Use idea to format codes
- Try to use existing client code for RegistrySKBAdminService
- Try to reduce while loops and introduce for each loops.
- Use Data Objects and Data Access Objects to handle Add,Get,Edit
Util classes.
If there are any missing points, please feel free to add here.
Thank you.
--
Manjula Rathnayaka
Software Engineer
WSO2, Inc.
Mobile:+94 77 743 1987
_______________________________________________
Carbon-dev mailing list
[email protected]
https://wso2.org/cgi-bin/mailman/listinfo/carbon-dev
