From 0f010d348a66e15012484e0fb57d9a263b4f68f7 Mon Sep 17 00:00:00 2001 From: bluegeek9 <5614-bluegeek9@users.noreply.drupalcode.org> Date: Wed, 15 Jan 2025 07:59:07 -0600 Subject: [PATCH] Issue #3499544 by bluegeek9: Add doc for KCS verified --- docs/capture/{01 integration.md => 01.md} | 15 +- docs/capture/{02 context.md => 02.md} | 14 +- docs/capture/{03 relevant.md => 03.md} | 14 +- docs/content health/01.md | 13 +- docs/content health/02.md | 13 +- docs/content health/03.md | 13 +- docs/content health/04.md | 15 +- docs/content health/05.md | 16 +- docs/content health/06.md | 15 +- docs/content health/07.md | 14 +- docs/content health/08.md | 9 +- docs/content health/09.md | 5 +- docs/content health/10.md | 5 +- docs/content health/11.md | 10 +- docs/content health/12.md | 6 +- docs/content health/13.md | 6 +- docs/improve/01.md | 13 +- docs/improve/02.md | 15 +- docs/improve/03.md | 13 +- docs/improve/04.md | 13 +- docs/improve/05.md | 14 +- docs/improve/06.md | 13 +- docs/performance assessment/01.md | 15 +- docs/performance assessment/02.md | 13 +- docs/performance assessment/03.md | 15 +- docs/performance assessment/04.md | 15 +- docs/performance assessment/05.md | 15 +- docs/performance assessment/06.md | 13 +- docs/performance assessment/07.md | 13 +- docs/performance assessment/08.md | 13 +- docs/performance assessment/09.md | 16 +- docs/performance assessment/10.md | 16 +- docs/performance assessment/11.md | 15 +- docs/performance assessment/12.md | 13 +- docs/performance assessment/13.md | 15 +- docs/performance assessment/14.md | 17 ++- docs/performance assessment/15.md | 13 +- docs/performance assessment/16.md | 13 +- docs/performance assessment/17.md | 12 +- docs/performance assessment/18.md | 6 +- docs/performance assessment/19.md | 9 +- docs/performance assessment/20.md | 6 +- docs/performance assessment/21.md | 6 +- docs/performance assessment/22.md | 6 +- docs/performance assessment/23.md | 8 +- docs/performance assessment/24.md | 15 +- docs/performance assessment/25.md | 15 +- docs/performance assessment/26.md | 13 +- docs/process integration/01.md | 15 +- docs/process integration/02.md | 12 +- docs/process integration/03.md | 13 +- docs/process integration/04.md | 15 +- docs/process integration/05.md | 12 +- docs/process integration/06.md | 8 + docs/process integration/07.md | 14 +- docs/process integration/08.md | 9 +- docs/process integration/09.md | 13 +- docs/process integration/10.md | 15 +- docs/process integration/11.md | 13 +- docs/reuse/01.md | 17 ++- docs/reuse/02.md | 5 + docs/reuse/03.md | 15 +- docs/reuse/04.md | 15 +- docs/reuse/05.md | 15 +- docs/reuse/06.md | 16 +- docs/reuse/07.md | 15 +- docs/scenario/01.md | 24 +++ docs/scenario/02.md | 24 +++ docs/scenario/03.md | 19 +++ docs/scenario/04.md | 19 +++ docs/scenario/05.md | 20 +++ docs/scenario/06.md | 11 ++ docs/scenario/07.md | 29 ++++ docs/scenario/08.md | 10 ++ docs/scenario/09.md | 17 +++ docs/scenario/10.md | 22 +++ docs/scenario/11.md | 20 +++ docs/structure/01.md | 15 +- docs/structure/02.md | 14 +- docs/structure/03.md | 15 +- docs/structure/04.md | 14 +- docs/structure/05.md | 13 +- docs/structure/06.md | 13 +- docs/structure/07.md | 13 +- docs/structure/08.md | 13 +- docs/structure/09.md | 15 +- docs/structure/10.md | 12 +- mkdocs.yml | 169 ++++++++++++---------- 88 files changed, 811 insertions(+), 537 deletions(-) rename docs/capture/{01 integration.md => 01.md} (97%) rename docs/capture/{02 context.md => 02.md} (97%) rename docs/capture/{03 relevant.md => 03.md} (97%) create mode 100644 docs/scenario/01.md create mode 100644 docs/scenario/02.md create mode 100644 docs/scenario/03.md create mode 100644 docs/scenario/04.md create mode 100644 docs/scenario/05.md create mode 100644 docs/scenario/06.md create mode 100644 docs/scenario/07.md create mode 100644 docs/scenario/08.md create mode 100644 docs/scenario/09.md create mode 100644 docs/scenario/10.md create mode 100644 docs/scenario/11.md diff --git a/docs/capture/01 integration.md b/docs/capture/01.md similarity index 97% rename from docs/capture/01 integration.md rename to docs/capture/01.md index 9586204..42d3a62 100644 --- a/docs/capture/01 integration.md +++ b/docs/capture/01.md @@ -1,3 +1,10 @@ +--- +tags: + - Process Integration + - Seamless Technology Integration + - Integration with Web Portals and Online Processes + - Scenario 01 +--- ##Mandatory## @@ -31,11 +38,3 @@ Scenario 1 ##Documentation## - - ---- -tags: - - Process Integration - - Seamless Technology Integration - - Integration with Web Portals and Online Processes ---- \ No newline at end of file diff --git a/docs/capture/02 context.md b/docs/capture/02.md similarity index 97% rename from docs/capture/02 context.md rename to docs/capture/02.md index 3a5b51a..618f0ab 100644 --- a/docs/capture/02 context.md +++ b/docs/capture/02.md @@ -1,3 +1,10 @@ +--- +tags: + - Capture + - Capture the Requestor's Context + - Scenario 01 +--- + ##Mandatory## As the issue is being solved information can be captured in the requestor's context and does not have to be re-typed to create an new article. @@ -27,10 +34,3 @@ Scenario 1 ##Documentation## - - ---- -tags: - - Capture - - Capture the Requestor's Context ---- \ No newline at end of file diff --git a/docs/capture/03 relevant.md b/docs/capture/03.md similarity index 97% rename from docs/capture/03 relevant.md rename to docs/capture/03.md index 8deded8..1312b8f 100644 --- a/docs/capture/03 relevant.md +++ b/docs/capture/03.md @@ -1,3 +1,10 @@ +--- +tags: + - Capture + - Capture Relevant Content + - Scenario 01 +--- + ##Mandatory## Preserved information can be edited or re-purposed into a KCS article. Searches shall be capable of being refined iteratively through rewording the search string, without requiring changes to the text of the incident record. Ideally, other methods of search refinement shall be provided as well (such as drill down by taxonomy, ontology, or tags.) @@ -28,10 +35,3 @@ Scenario 1 ##Documentation## - - ---- -tags: - - Capture - - Capture Relevant Content ---- \ No newline at end of file diff --git a/docs/content health/01.md b/docs/content health/01.md index aafe447..b98fce2 100644 --- a/docs/content health/01.md +++ b/docs/content health/01.md @@ -1,3 +1,10 @@ +--- +tags: + - Content Health + - The KCS Article State + - Scenario 03 +--- + ##Mandatory## For each KCS article, the system shall record: @@ -34,9 +41,3 @@ Scenario 3 ##Documentation## - ---- -tags: - - Content Health - - The KCS Article State ---- \ No newline at end of file diff --git a/docs/content health/02.md b/docs/content health/02.md index deaeb5a..6dafd75 100644 --- a/docs/content health/02.md +++ b/docs/content health/02.md @@ -1,3 +1,10 @@ +--- +tags: + - Reuse + - Linking + - Scenario 03 +--- + ##Mandatory## For each KCS article, the system shall record for an identified audience(internal vs external), date, role @@ -31,9 +38,3 @@ Scenario 3 ##Documentation## - ---- -tags: - - Reuse - - Linking ---- \ No newline at end of file diff --git a/docs/content health/03.md b/docs/content health/03.md index b005c2a..b166ac0 100644 --- a/docs/content health/03.md +++ b/docs/content health/03.md @@ -1,3 +1,10 @@ +--- +tags: + - Content Health + - The KCS Article State + - Scenario 01 +--- + ##Mandatory## The system shall support content being in a minimum of four article confidence levels: @@ -33,9 +40,3 @@ Scenario 1 ##Documentation## - ---- -tags: - - Content Health - - The KCS Article State ---- \ No newline at end of file diff --git a/docs/content health/04.md b/docs/content health/04.md index 7543f11..70cdf8b 100644 --- a/docs/content health/04.md +++ b/docs/content health/04.md @@ -1,3 +1,11 @@ +--- +tags: + - Content Health + - The KCS Article State + - Article Visibility Who Gets to See What + - Scenario 07 +--- + ##Mandatory## Articles in each confidence level WIP, Not Validated, Validated, Archive, shall be searchable and visible to an appropriately entitled knowledge workers based on license level, audience, and governance. @@ -30,10 +38,3 @@ Scenario 7 ##Documentation## - ---- -tags: - - Content Health - - The KCS Article State - - Article Visibility: Who Gets to See What ---- \ No newline at end of file diff --git a/docs/content health/05.md b/docs/content health/05.md index acefabe..9bd6729 100644 --- a/docs/content health/05.md +++ b/docs/content health/05.md @@ -1,3 +1,11 @@ +--- +tags: + - Content Health + - Assessing the Value of Articles + - Article value based on reuse + - Not Mandatory +--- + ##Not Mandatory## Specific staff, for example KCS Publishers or KDE's, shall have the ability to see articles that are Not Validated, and that have been linked to N incidents, where N may be a site-configurable or individually settable parameter. This mechanism may be implemented, for example, through a search or a special queue. @@ -27,11 +35,3 @@ Technique 5.10: Content Health Indicators ##Documentation## - - ---- -tags: - - Content Health - - Assessing the Value of Articles - - Article value based on reuse ---- \ No newline at end of file diff --git a/docs/content health/06.md b/docs/content health/06.md index efd302b..e5a56fe 100644 --- a/docs/content health/06.md +++ b/docs/content health/06.md @@ -1,3 +1,11 @@ +--- +tags: + - Content Health + - Self-Service Measures + - Integrating Feedback + - Scenario 02 +--- + ##Mandatory## Processing customer feedback on KCS articles. Ability to trigger workflow in order to process the feedback. Respond, track and report on it. Flag completed. Provide feedback of the value of giving feedback. Same concept as Flag-it on article. Should be done at any point where feedback is provided. (Ideally - to report on turn around time. @@ -32,10 +40,3 @@ Scenario 2 ##Documentation## - ---- -tags: - - Content Health - - Self-Service Measures - - Integrating Feedback ---- \ No newline at end of file diff --git a/docs/content health/07.md b/docs/content health/07.md index dc69725..a799848 100644 --- a/docs/content health/07.md +++ b/docs/content health/07.md @@ -1,3 +1,11 @@ +--- +tags: + - Content Health + - Self-service Success + - Not Mandatory + - Scenario 07 +--- + ##Not Mandatory## Mechanism to configure rules to automatically publish KCS articles. @@ -27,9 +35,3 @@ Scenario 7 ##Documentation## - ---- -tags: - - Content Health - - Self-service Success ---- \ No newline at end of file diff --git a/docs/content health/08.md b/docs/content health/08.md index be40284..4a71ab4 100644 --- a/docs/content health/08.md +++ b/docs/content health/08.md @@ -1,3 +1,8 @@ +--- +tags: + - Not Mandatory +--- + ##Not Mandatory## Enable a configuration that allows an external audience or end users in the community to reuse, create, and modify KCS articles @@ -24,7 +29,3 @@ Enable a configuration that allows an external audience or end users in the comm ##Documentation## - ---- -tags: ---- \ No newline at end of file diff --git a/docs/content health/09.md b/docs/content health/09.md index 42fa3db..8be84a6 100644 --- a/docs/content health/09.md +++ b/docs/content health/09.md @@ -1,3 +1,4 @@ + ##Mandatory## Describe your strategy and licensing model to author content both internally and externally. (example: Single user named license internal to the company can create content in the knowledge base, vs unlimited number of users can create knowledge in the knowledge base vs. external customers can create draft knowledge in the knowledge base) @@ -24,7 +25,3 @@ Describe your strategy and licensing model to author content both internally and ##Documentation## - ---- -tags: ---- \ No newline at end of file diff --git a/docs/content health/10.md b/docs/content health/10.md index 7262fd2..f8f5c91 100644 --- a/docs/content health/10.md +++ b/docs/content health/10.md @@ -1,3 +1,4 @@ + ##Mandatory## Describe the self-service access point (integrated into product, mobile app, portal or web page) @@ -24,7 +25,3 @@ Technique 5.11: Self-Service Success ##Documentation## - ---- -tags: ---- \ No newline at end of file diff --git a/docs/content health/11.md b/docs/content health/11.md index 38d79bb..37e7d2b 100644 --- a/docs/content health/11.md +++ b/docs/content health/11.md @@ -1,3 +1,8 @@ +--- +tags: + - Not Mandatory +--- + ##Not Mandatory## Navigation in self-service mechanism aligns to the requestor's intent @@ -24,8 +29,3 @@ Technique 5.11: Self-Service Success ##Documentation## - ---- -tags: - - ---- \ No newline at end of file diff --git a/docs/content health/12.md b/docs/content health/12.md index 5dd4154..2f455d4 100644 --- a/docs/content health/12.md +++ b/docs/content health/12.md @@ -1,3 +1,5 @@ + + ##Mandatory## Navigation in self-service transitions to assisted support (click to submit an incident or click to chat) @@ -24,7 +26,3 @@ Technique 5.11: Self-Service Success ##Documentation## - ---- -tags: ---- \ No newline at end of file diff --git a/docs/content health/13.md b/docs/content health/13.md index 8a32059..87413ad 100644 --- a/docs/content health/13.md +++ b/docs/content health/13.md @@ -1,3 +1,5 @@ + + ##Mandatory## Navigation in self-service provides for both browsing and searching (product specific, indexed table of context, FAQ's, basic search, advanced search) @@ -24,7 +26,3 @@ Technique 5.11: Self-Service Success ##Documentation## - ---- -tags: ---- \ No newline at end of file diff --git a/docs/improve/01.md b/docs/improve/01.md index 7c0e5a4..2b83375 100644 --- a/docs/improve/01.md +++ b/docs/improve/01.md @@ -1,3 +1,10 @@ +--- +tags: + - Improve + - Flag it or Fix it + - Scenario 02 +--- + ##Mandatory## The system shall support a KCS Candidate finding and flagging content that needs to be reworked. The flag will be visible to at least other internal users. The flagger will have the ability to append feedback to indicate the reason for rework. @@ -27,9 +34,3 @@ Scenario 2 ##Documentation## - ---- -tags: - - Improve - - Flag it or Fix it ---- \ No newline at end of file diff --git a/docs/improve/02.md b/docs/improve/02.md index ae64c79..08a0fa3 100644 --- a/docs/improve/02.md +++ b/docs/improve/02.md @@ -1,3 +1,11 @@ +--- +tags: + - Improve + - Flag it or Fix it + - License to Modify + - Scenario 02 +--- + ##Mandatory## System shall support KCS Contributor finding and fixing KCS article immediately. @@ -29,10 +37,3 @@ Scenario 2 ##Documentation## - ---- -tags: - - Improve - - Flag it or Fix it - - License to Modify ---- \ No newline at end of file diff --git a/docs/improve/03.md b/docs/improve/03.md index 37f6d87..bb713d5 100644 --- a/docs/improve/03.md +++ b/docs/improve/03.md @@ -1,3 +1,10 @@ +--- +tags: + - Improve + - Flag it or Fix it + - Scenario 02 +--- + ##Mandatory## All users, including external self-service users, shall have the ability to provide feedback on KCS article, such as ratings, verbatim comments or both. @@ -27,9 +34,3 @@ Scenario 2 ##Documentation## - ---- -tags: - - Improve - - Flag it or Fix it ---- \ No newline at end of file diff --git a/docs/improve/04.md b/docs/improve/04.md index fb77e2f..dbe3f90 100644 --- a/docs/improve/04.md +++ b/docs/improve/04.md @@ -1,3 +1,10 @@ +--- +tags: + - Improve + - Duplicate Articles + - Scenario 01 +--- + ##Mandatory## During the course of knowledge capture, after the user has entered content into an article, the system shall provide a function to help identify duplicate content by issuing a search based on the content currently entered in the new article. This function shall be available to the user during the course of article capture and immediately prior to submitting the article for saving into the knowledge base. @@ -27,9 +34,3 @@ Scenario 1 ##Documentation## - ---- -tags: - - Improve - - Duplicate Articles ---- \ No newline at end of file diff --git a/docs/improve/05.md b/docs/improve/05.md index 98b0f46..705e207 100644 --- a/docs/improve/05.md +++ b/docs/improve/05.md @@ -1,3 +1,11 @@ +--- +tags: + - Improve + - Dealing with Duplicates - The Merge + - Not Mandatory + - Scenario 06 +--- + ##Not Mandatory## System shall support a function to merge duplicates. Newer articles content and links to incidents merges into the older article and the newer article gets archived or deleted. @@ -27,9 +35,3 @@ Scenario 6 ##Documentation## - ---- -tags: - - Improve - - Dealing with Duplicates - The Merge ---- \ No newline at end of file diff --git a/docs/improve/06.md b/docs/improve/06.md index c1cbbfe..c68856f 100644 --- a/docs/improve/06.md +++ b/docs/improve/06.md @@ -1,3 +1,10 @@ +--- +tags: + - Improve + - Dealing with Duplicates - The Merge + - Scenario 06 +--- + ##Mandatory## System shall support the ability to view and edit multiple articles simultaneously in order to merge duplicate articles by editing and changing state. @@ -28,9 +35,3 @@ Scenario 6 ##Documentation## - ---- -tags: - - Improve - - Dealing with Duplicates - The Merge ---- \ No newline at end of file diff --git a/docs/performance assessment/01.md b/docs/performance assessment/01.md index 5766d26..55fac43 100644 --- a/docs/performance assessment/01.md +++ b/docs/performance assessment/01.md @@ -1,3 +1,11 @@ +--- +tags: + - Performance Assessment + - Assessing the Creation of Value + - Measures for Individuals and Teams + - Scenario 09 +--- + ##Mandatory## The system shall provide reports showing documents created, modified, and flagged by anyone who has contributed to any version of the article over time for a particular time period. These reports will be capable of segmentation by individual, team (group of users and knowledge domain (category, tag, or node), @@ -27,10 +35,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Performance Assessment - - Assessing the Creation of Value - - Measures for Individuals and Teams ---- \ No newline at end of file diff --git a/docs/performance assessment/02.md b/docs/performance assessment/02.md index 80ae7af..7194f08 100644 --- a/docs/performance assessment/02.md +++ b/docs/performance assessment/02.md @@ -1,3 +1,10 @@ +--- +tags: + - Performance Assessment + - Assessing the Creation of Value + - Scenario 09 +--- + ##Mandatory## The system shall provide reports showing citation rates for an individual or team (group of users) and knowledge domain (category, tag, or node). @@ -26,9 +33,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Performance Assessment - - Assessing the Creation of Value ---- \ No newline at end of file diff --git a/docs/performance assessment/03.md b/docs/performance assessment/03.md index 83c707c..9fda3f9 100644 --- a/docs/performance assessment/03.md +++ b/docs/performance assessment/03.md @@ -1,3 +1,11 @@ +--- +tags: + - Performance Assessment + - Assessing the Creation of Value + - Link Rate as an Indicator + - Scenario 09 +--- + ##Mandatory## The system shall provide reports showing a link rate indicator for a particular time period. These reports will be capable of segmentation by individual, team (group of users) and knowledge domain (category, tag, or role). @@ -27,10 +35,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Performance Assessment - - Assessing the Creation of Value - - Link Rate as an Indicator ---- \ No newline at end of file diff --git a/docs/performance assessment/04.md b/docs/performance assessment/04.md index 07ba9fe..53cb5b2 100644 --- a/docs/performance assessment/04.md +++ b/docs/performance assessment/04.md @@ -1,3 +1,11 @@ +--- +tags: + - Performance Assessment + - Assessing the Creation of Value + - KCS Article Life Cycle Trend + - Scenario 09 +--- + ##Mandatory## The system shall provide reports showing the number of documents in each article state and date/times indicating how long they have been in each state.These reports will be capable of segmentation by knowledge domain (category, tag, or role.) @@ -27,10 +35,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Performance Assessment - - Assessing the Creation of Value - - KCS Article Life Cycle Trend ---- \ No newline at end of file diff --git a/docs/performance assessment/05.md b/docs/performance assessment/05.md index 9cd66c1..b6bce42 100644 --- a/docs/performance assessment/05.md +++ b/docs/performance assessment/05.md @@ -1,3 +1,11 @@ +--- +tags: + - Content Health + - Managing KCS Article Quality + - The Article Quality Index + - Scenario 09 +--- + ##Mandatory## The system shall provide reports/enables showing the Content Standard Checklist with associated KCS article reference. These reports will be capable of segmentation by individual, team (designated by coach). Visibility should be limited to Coach, Author, and Author's Manager. @@ -27,10 +35,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Content Health - - Managing KCS Article Quality - - The Article Quality Index ---- \ No newline at end of file diff --git a/docs/performance assessment/06.md b/docs/performance assessment/06.md index 340ddc8..c702b4e 100644 --- a/docs/performance assessment/06.md +++ b/docs/performance assessment/06.md @@ -1,3 +1,10 @@ +--- +tags: + - Process Integration + - KCS Process Integration Indicators + - Scenario 09 +--- + ##Mandatory## The system shall provide/enables reports showing the PAR (link accuracy and capture loss only) with associated KCS article reference. These reports will be capable of segmentation by individual, team (designated by coach) @@ -26,9 +33,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Process Integration - - KCS Process Integration Indicators ---- \ No newline at end of file diff --git a/docs/performance assessment/07.md b/docs/performance assessment/07.md index 0be54da..cd22af7 100644 --- a/docs/performance assessment/07.md +++ b/docs/performance assessment/07.md @@ -1,3 +1,10 @@ +--- +tags: + - Reuse + - Linking + - Scenario 09 +--- + ##Mandatory## The system shall provide reports showing how often KCS articles (mandatory) and other content types (non-mandatory) are linked to and from incidents. These reports will be capable of segmentation by date, knowledge domain (category, tag, or role.) @@ -29,9 +36,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Reuse - - Linking ---- \ No newline at end of file diff --git a/docs/performance assessment/08.md b/docs/performance assessment/08.md index a2037de..e25c3bc 100644 --- a/docs/performance assessment/08.md +++ b/docs/performance assessment/08.md @@ -1,3 +1,10 @@ +--- +tags: + - Closing Thoughts on the Solve Loop + - Collective Ownership in the Solve Loop + - Scenario 09 +--- + ##Mandatory## The system shall provide reports showing history of the KCS article and the individuals that have contributed over a particular period of time. These reports will be capable of segmentation by individual, team (group of users), date, and knowledge domain (category, tag, or role). @@ -26,9 +33,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Closing Thoughts on the Solve Loop - - Collective Ownership in the Solve Loop ---- \ No newline at end of file diff --git a/docs/performance assessment/09.md b/docs/performance assessment/09.md index 1f3d12c..db051dd 100644 --- a/docs/performance assessment/09.md +++ b/docs/performance assessment/09.md @@ -1,3 +1,12 @@ +--- +tags: + - Reuse + - Linking + - Referencing or Linking to Other Information Sources + - Not Mandatory + - Scenario 09 +--- + ##Not Mandatory## The system shall provide reports showing how often a KCS article was used as a reference over a particular period of time. These reports will be capable of segmentation by individual, team (group of users), knowledge domain (category, tag, or role), and date. @@ -27,10 +36,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Reuse - - Linking - - Referencing or Linking to Other Information Sources ---- \ No newline at end of file diff --git a/docs/performance assessment/10.md b/docs/performance assessment/10.md index 7f70d1b..1102a2b 100644 --- a/docs/performance assessment/10.md +++ b/docs/performance assessment/10.md @@ -1,3 +1,11 @@ +--- +tags: + - Content Health + - Knowledge Domain Analysis + - Creating Evolve Loop Articles + - Methods for Prioritizing Root Cause Analysis +--- + ##Mandatory## The system shall provide a report showing a graph of distribution of reuse counts for KCS articles over a particular period of time.These reports will be capable of segmentation by knowledge domain (category, tag, or role.), date, owner, creator @@ -30,11 +38,3 @@ The system shall provide a report showing a graph of distribution of reuse count ##Documentation## - ---- -tags: - - Content Health - - Knowledge Domain Analysis - - Creating Evolve Loop Articles - - Methods for Prioritizing Root Cause Analysis ---- \ No newline at end of file diff --git a/docs/performance assessment/11.md b/docs/performance assessment/11.md index cc7f237..e4b30d9 100644 --- a/docs/performance assessment/11.md +++ b/docs/performance assessment/11.md @@ -1,3 +1,11 @@ +--- +tags: + - Performance Assessment + - Assessing the Creation of Value + - Radar Charts - Creating a Value Footprint + - Scenario 09 +--- + ##Mandatory## The system shall provide reports showing a Radar chart for an individual over a particular period of time that contains these mandatory elements: @@ -37,10 +45,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Performance Assessment - - Assessing the Creation of Value - - Radar Charts - Creating a Value Footprint ---- \ No newline at end of file diff --git a/docs/performance assessment/12.md b/docs/performance assessment/12.md index 4654193..59f9fa8 100644 --- a/docs/performance assessment/12.md +++ b/docs/performance assessment/12.md @@ -1,3 +1,10 @@ +--- +tags: + - Content Health + - Self-Service Measures + - Scenario 09 +--- + ##Mandatory## The system shall provide reports showing the following self-service metrics over a particular period of time. @@ -35,9 +42,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Content Health - - Self-Service Measures ---- \ No newline at end of file diff --git a/docs/performance assessment/13.md b/docs/performance assessment/13.md index 4c5f1dc..eb5894a 100644 --- a/docs/performance assessment/13.md +++ b/docs/performance assessment/13.md @@ -1,3 +1,11 @@ +--- +tags: + - Content Health + - Self-Service Measures + - Integrating Feedback + - Scenario 09 +--- + ##Mandatory## The system shall provide reports showing the following article feedback. @@ -32,10 +40,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Content Health - - Self-Service Measures - - Integrating Feedback ---- \ No newline at end of file diff --git a/docs/performance assessment/14.md b/docs/performance assessment/14.md index 9411773..d441beb 100644 --- a/docs/performance assessment/14.md +++ b/docs/performance assessment/14.md @@ -1,3 +1,12 @@ +--- +tags: + - Content Health + - KCS Article State + - Performance Assessment + - KCS Roles and the Licensing Model + - Scenario 07 +--- + ##Mandatory## The system shall provide visibility management options that uses the user role, from user profiles, along with article quality, article confidence, article governance or other article attributes to determine visibility. This visibility must at minimum be article level and ideally in-line or at the field or statement level. @@ -28,11 +37,3 @@ Scenario 7 ##Documentation## - ---- -tags: - - Content Health - - KCS Article State - - Performance Assessment - - KCS Roles and the Licensing Model ---- \ No newline at end of file diff --git a/docs/performance assessment/15.md b/docs/performance assessment/15.md index c9478bc..44d0891 100644 --- a/docs/performance assessment/15.md +++ b/docs/performance assessment/15.md @@ -1,3 +1,10 @@ +--- +tags: + - Performance Assessment + - KCS Roles and the Licensing Model + - Scenario 07 +--- + ##Mandatory## KCS articles in each level of audience shall be searchable and visible to an appropriate KCS license level. For example, a KCS Contributor might have access to view all articles, a KCS Candidate might have access to view Non-Verified and Verified articles, and customer end-users might have access to only Verified/External articles. @@ -26,9 +33,3 @@ Scenario 7 ##Documentation## - ---- -tags: - - Performance Assessment - - KCS Roles and the Licensing Model ---- \ No newline at end of file diff --git a/docs/performance assessment/16.md b/docs/performance assessment/16.md index a698f66..1134d68 100644 --- a/docs/performance assessment/16.md +++ b/docs/performance assessment/16.md @@ -1,3 +1,10 @@ +--- +tags: + - Performance Assessment + - KCS Roles and the Licensing Model + - Scenario 07 +--- + ##Mandatory## KCS articles in each level of governance shall be editable to an appropriate KCS license level. For example, a KCS Contributor might have access to edit a Non-Validated Compliance Based article but only a small user group would be designated to edit Validated articles. @@ -26,9 +33,3 @@ Scenario 7 ##Documentation## - ---- -tags: - - Performance Assessment - - KCS Roles and the Licensing Model ---- \ No newline at end of file diff --git a/docs/performance assessment/17.md b/docs/performance assessment/17.md index 7818958..7a069d9 100644 --- a/docs/performance assessment/17.md +++ b/docs/performance assessment/17.md @@ -1,3 +1,9 @@ +--- +tags: + - Performance Assessment + - Coaching +--- + ##Mandatory/Not Mandatory## The Coach's focus should first be on evolving an individual's KCS skills, then, over time, shift to developing team capabilities. Although organizations recognize the need for training, they often overlook the need for coaching. @@ -26,9 +32,3 @@ Technique 7.2: Coaching for Success ##Documentation## - ---- -tags: - - Performance Assessment - - Coaching ---- \ No newline at end of file diff --git a/docs/performance assessment/18.md b/docs/performance assessment/18.md index 5db61bf..18fa2ad 100644 --- a/docs/performance assessment/18.md +++ b/docs/performance assessment/18.md @@ -1,3 +1,5 @@ + + ##Mandatory## Mechanism for integration of reporting tools. In documentation column list all possible export formats. @@ -24,7 +26,3 @@ Mechanism for integration of reporting tools. In documentation column list all p ##Documentation## - ---- -tags: ---- \ No newline at end of file diff --git a/docs/performance assessment/19.md b/docs/performance assessment/19.md index 4648513..4072fea 100644 --- a/docs/performance assessment/19.md +++ b/docs/performance assessment/19.md @@ -1,3 +1,8 @@ +--- +tags: + - Not Mandatory +--- + ##Not Mandatory## Mechanism for storing article activity data. Describe in documentation column. @@ -23,7 +28,3 @@ Mechanism for storing article activity data. Describe in documentation column. ##Documentation## - ---- -tags: ---- \ No newline at end of file diff --git a/docs/performance assessment/20.md b/docs/performance assessment/20.md index 0bc9adb..fd873de 100644 --- a/docs/performance assessment/20.md +++ b/docs/performance assessment/20.md @@ -1,3 +1,5 @@ + + ##Mandatory## Data structure for articles/incidents, API and tools available. Describe in documentation column. @@ -24,7 +26,3 @@ Data structure for articles/incidents, API and tools available. Describe in doc ##Documentation## - ---- -tags: ---- \ No newline at end of file diff --git a/docs/performance assessment/21.md b/docs/performance assessment/21.md index 590b723..d84ac2e 100644 --- a/docs/performance assessment/21.md +++ b/docs/performance assessment/21.md @@ -1,3 +1,5 @@ + + ##Mandatory## Mechanism for performing Calculations. Describe in documentation column. @@ -24,7 +26,3 @@ Mechanism for performing Calculations. Describe in documentation column. ##Documentation## - ---- -tags: ---- \ No newline at end of file diff --git a/docs/performance assessment/22.md b/docs/performance assessment/22.md index 1b72be3..c8ded3f 100644 --- a/docs/performance assessment/22.md +++ b/docs/performance assessment/22.md @@ -1,3 +1,5 @@ + + ##Mandatory## Third party tools required for reporting (use documentation column) @@ -24,7 +26,3 @@ Third party tools required for reporting (use documentation column) ##Documentation## - ---- -tags: ---- \ No newline at end of file diff --git a/docs/performance assessment/23.md b/docs/performance assessment/23.md index 0d59315..8505502 100644 --- a/docs/performance assessment/23.md +++ b/docs/performance assessment/23.md @@ -1,6 +1,8 @@ + + ##Mandatory## -Mechanism for grouping article activities, individual and group, distinguish between all contributors (define in documentation column how individual contribution is extracted, initial author, last modified, assigned owner, all historical contributors across versions. +Mechanism for grouping article activities, individual and group, distinguish between all contributors define in documentation column how individual contribution is extracted, initial author, last modified, assigned owner, all historical contributors across versions. ##Practice/Technique## @@ -23,7 +25,3 @@ Mechanism for grouping article activities, individual and group, distinguish bet ##Documentation## - ---- -tags: ---- \ No newline at end of file diff --git a/docs/performance assessment/24.md b/docs/performance assessment/24.md index 4c772cd..d2a6cbc 100644 --- a/docs/performance assessment/24.md +++ b/docs/performance assessment/24.md @@ -1,3 +1,11 @@ +--- +tags: + - Content Health + - Creating Evolve Loop Articles + - Plugging Content Gaps Identified from the Web + - Scenario 11 +--- + ##Mandatory## Report on the self-service experience and internal search effectiveness analysis on search success and effectiveness. (Could used Normalized Discounted Cumulative Gain. Could use escalation @@ -30,10 +38,3 @@ Scenario 11 ##Documentation## - ---- -tags: - - Content Health - - Creating Evolve Loop Articles - - Plugging Content Gaps Identified from the Web ---- \ No newline at end of file diff --git a/docs/performance assessment/25.md b/docs/performance assessment/25.md index 301f6eb..e13865b 100644 --- a/docs/performance assessment/25.md +++ b/docs/performance assessment/25.md @@ -1,3 +1,11 @@ +--- +tags: + - Content Health + - Creating Evolve Loop Articles + - Plugging Content Gaps Identified from the Web + - Scenario 11 +--- + ##Mandatory## Report on passive failed search. Abandoned, ability to filter and trigger and the ability to report on. @@ -27,10 +35,3 @@ Scenario 11 ##Documentation## - ---- -tags: - - Content Health - - Creating Evolve Loop Articles - - Plugging Content Gaps Identified from the Web ---- \ No newline at end of file diff --git a/docs/performance assessment/26.md b/docs/performance assessment/26.md index 08692fd..9e2a119 100644 --- a/docs/performance assessment/26.md +++ b/docs/performance assessment/26.md @@ -1,3 +1,10 @@ +--- +tags: + - Content Health + - Knowledge Domain Analysis + - Not Mandatory +--- + ##Not Mandatory## Enable analytics in the evolve loop: for example (but not limited to) ability to identify common symptoms with different causes, common causes with different symptoms, patterns based on environment statements @@ -26,9 +33,3 @@ Technique 5.9: Knowledge Domain Analysis ##Documentation## - ---- -tags: - - Content Health - - Knowledge Domain Analysis ---- \ No newline at end of file diff --git a/docs/process integration/01.md b/docs/process integration/01.md index abdb8e4..9232d6a 100644 --- a/docs/process integration/01.md +++ b/docs/process integration/01.md @@ -1,3 +1,11 @@ +--- +tags: + - Process Integration + - Seamless Technology Integration + - Integration of Workflow and Technology with CRM, IM, and Other Tools + - Scenario 01 +--- + ##Mandatory## User interface and integrated workflow @@ -27,10 +35,3 @@ Scenario 1 ##Documentation## - ---- -tags: - - Process Integration - - Seamless Technology Integration - - Integration of Workflow and Technology with CRM, IM, and Other Tools ---- \ No newline at end of file diff --git a/docs/process integration/02.md b/docs/process integration/02.md index 167e2f6..df542c1 100644 --- a/docs/process integration/02.md +++ b/docs/process integration/02.md @@ -1,3 +1,9 @@ +--- +tags: + - Process Integration + - Search Technology for KCS +--- + ##Mandatory## Meta Data Management – Ability to use metadata to change the ranking, filtering, and relevance of search results. Metadata can include: @@ -30,9 +36,3 @@ Technique 6.3: Search Technology for KCS ##Documentation## - ---- -tags: - - Process Integration - - Search Technology for KCS ---- \ No newline at end of file diff --git a/docs/process integration/03.md b/docs/process integration/03.md index 36d71b2..1da2d62 100644 --- a/docs/process integration/03.md +++ b/docs/process integration/03.md @@ -1,3 +1,10 @@ +--- +tags: + - Process Integration + - Search Technology for KCS + - Not Mandatory +--- + ##Not Mandatory## Describe the capabilities for personalization to audiences, known individuals, or contexts @@ -26,9 +33,3 @@ Technique 6.3: Search Technology for KCS ##Documentation## - ---- -tags: - - Process Integration - - Search Technology for KCS ---- \ No newline at end of file diff --git a/docs/process integration/04.md b/docs/process integration/04.md index 4c5fb5f..47fd34b 100644 --- a/docs/process integration/04.md +++ b/docs/process integration/04.md @@ -1,3 +1,10 @@ +--- +tags: + - Process Integration + - Search Technology for KCS + - Not Mandatory +--- + ##Not Mandatory## Aggregated Search – Access to content repositories with relevant content outside the knowledge base, using approaches such as spidering / crawling of external content repositories, or federating of external search systems @@ -5,7 +12,7 @@ Aggregated Search – Access to content repositories with relevant content outsi ##Practice/Technique## * Process Integration -* Technology for KCS +* Technology for KCS ##Reference: KCS v6 Practices Guide## Technique 6.3: Search Technology for KCS @@ -26,9 +33,3 @@ Technique 6.3: Search Technology for KCS ##Documentation## - ---- -tags: - - Process Integration - - Search Technology for KCS ---- \ No newline at end of file diff --git a/docs/process integration/05.md b/docs/process integration/05.md index 287a26b..db1f194 100644 --- a/docs/process integration/05.md +++ b/docs/process integration/05.md @@ -1,3 +1,9 @@ +--- +tags: + - Process Integration + - Search Technology for KCS +--- + ##Mandatory## Describe the search capabilities and how they return relevant results, appropriately ranked, to analyst and customer. Examples include: stemming, lemmatization, tagging, concept matching, user intent, machine learning, consensus tagging, autocomplete/typeahead, autosuggest, spelling correction, "did you mean," relevance ranking, search cases, multi-contextual sensitivity @@ -26,9 +32,3 @@ Technique 6.3: Search Technology for KCS ##Documentation## - ---- -tags: - - Process Integration - - Search Technology for KCS ---- \ No newline at end of file diff --git a/docs/process integration/06.md b/docs/process integration/06.md index 5cab81c..f699003 100644 --- a/docs/process integration/06.md +++ b/docs/process integration/06.md @@ -1,3 +1,11 @@ +--- +tags: + - Process Integration + - Search Technology of KCS + - Planning for the Ongoing Effort of Search Tuning + - Scenario 07 +--- + ##Mandatory## The system shall provide the ability to perform search tuning. Describe the mechanism for search tuning (machine learning, user interface, or no interface. In addition to listing the technical features describe the process and the strategy you recommend for ongoing tuning. diff --git a/docs/process integration/07.md b/docs/process integration/07.md index 761bbc9..7216faf 100644 --- a/docs/process integration/07.md +++ b/docs/process integration/07.md @@ -1,3 +1,10 @@ +--- +tags: + - Process Integration + - Search Technology of KCS + - Planning for the Ongoing Effort of Search Tuning +--- + ##Mandatory## The system shall provide the ability for real time indexing (searchable and findable) for intended audience , less than 5 min. for internal knowledge workers, less than 90 minutes for authenticated external customers. System shall provide indexing for external web content content (indexed by Google, Bing etc.) @@ -27,10 +34,3 @@ Technique 6.3: Search Technology for KCS ##Documentation## - ---- -tags: - - Process Integration - - Search Technology of KCS - - Planning for the Ongoing Effort of Search Tuning ---- \ No newline at end of file diff --git a/docs/process integration/08.md b/docs/process integration/08.md index ba883ac..6f1e31f 100644 --- a/docs/process integration/08.md +++ b/docs/process integration/08.md @@ -1,3 +1,8 @@ +--- +tags: + - Not Mandatory +--- + ##Not Mandatory## Describe your process for publishing content to the web and SEO. @@ -28,7 +33,3 @@ Describe your process for publishing content to the web and SEO. ##Documentation## - ---- -tags: ---- \ No newline at end of file diff --git a/docs/process integration/09.md b/docs/process integration/09.md index 5ea85c7..93855bf 100644 --- a/docs/process integration/09.md +++ b/docs/process integration/09.md @@ -1,3 +1,10 @@ +--- +tags: + - Structure + - Utilize Simple Templates + - Not Mandatory +--- + ##Not Mandatory## Administrators can adjust KCS Article structured such that the search engine can apply different weights by field, include/exclude fields in the search @@ -26,9 +33,3 @@ Technique 5.1: KCS Article Structure ##Documentation## - ---- -tags: - - Structure - - Utilize Simple Templates ---- \ No newline at end of file diff --git a/docs/process integration/10.md b/docs/process integration/10.md index 180125c..795c87e 100644 --- a/docs/process integration/10.md +++ b/docs/process integration/10.md @@ -1,3 +1,11 @@ +--- +tags: + - Content Health + - Self-Service Success + - Not Mandatory + - Scenario 01 +--- + ##Not Mandatory## The system shall extend this navigation or browsing experience to external (non knowledge base) content indexed by the system @@ -27,10 +35,3 @@ Scenario 1 ##Documentation## - ---- -tags: - - Content Health - - Self-Service Success - ---- \ No newline at end of file diff --git a/docs/process integration/11.md b/docs/process integration/11.md index 14b9f27..2640dd6 100644 --- a/docs/process integration/11.md +++ b/docs/process integration/11.md @@ -1,3 +1,9 @@ +--- +tags: + - Process Integration + - Seamless Technology Integration +--- + ##Mandatory## The system shall provide an integrated search and navigation experience, where a user can start with a search and further refine (navigate) based on metadata tags, or can initiate a search that is restricted to a particular part of a browse tree. @@ -27,10 +33,3 @@ Technique 6.2: Seamless Technology Integration ##Documentation## - ---- -tags: - - Process Integration - - Seamless Technology Integration - ---- \ No newline at end of file diff --git a/docs/reuse/01.md b/docs/reuse/01.md index 7ea52c6..f2f0008 100644 --- a/docs/reuse/01.md +++ b/docs/reuse/01.md @@ -1,9 +1,17 @@ +--- +tags: + - Reuse + - Linking + - Linking an Incident to Non-KCS Content + - Not Mandatory +--- + ##Not Mandatory## Content from other sources (user community, discussion forums, etc.) be added to the knowledge base or within the tools, what content types are supported. 3 Approaches: 1. Single source content authored in KB tool. (mandatory) -2. Same index applied to external sources (ie. .pdf, .docs, external via API) master source resides outside of KB (non-mandatory) +2. Same index applied to external sources (ie. .pdf, .docs, external via API) master source resides outside of KB (non-mandatory) 3. Federated search (non-mandatory) ##Practice/Technique## @@ -32,10 +40,3 @@ Content from other sources (user community, discussion forums, etc.) be added to ##Documentation## - ---- -tags: - - Reuse - - Linking - - Linking an Incident to Non-KCS Content ---- \ No newline at end of file diff --git a/docs/reuse/02.md b/docs/reuse/02.md index b534700..d34a8a6 100644 --- a/docs/reuse/02.md +++ b/docs/reuse/02.md @@ -1,3 +1,8 @@ +--- +tags: + - Scenario 01 +--- + ##Mandatory## The system shall support the provisioning of internal (inside the firewall) and external (outside the firewall, or in a DMZ) access to a single logical knowledge base. Changes to the master knowledge base will be reflected appropriately in each end-user’s experience. diff --git a/docs/reuse/03.md b/docs/reuse/03.md index 1333876..57a286f 100644 --- a/docs/reuse/03.md +++ b/docs/reuse/03.md @@ -1,3 +1,11 @@ +--- +tags: + - Reuse + - Linking + - Referencing and Linking to Other Information Sources + - Not Mandatory +--- + ##Not Mandatory## The system shall provide a mechanism to distinguish a reference link from a resolution/fix link. (This can be done through meta-data and shall have capability to be reported on.) @@ -28,10 +36,3 @@ The system shall provide a mechanism to distinguish a reference link from a reso ##Documentation## - ---- -tags: - - Reuse - - Linking - - Referencing and Linking to Other Information Sources ---- \ No newline at end of file diff --git a/docs/reuse/04.md b/docs/reuse/04.md index 7013b8d..4953e15 100644 --- a/docs/reuse/04.md +++ b/docs/reuse/04.md @@ -1,3 +1,11 @@ +--- +tags: + - Reuse + - Linking + - Many-to-Many Relationship Between Incidents and Articles + - Scenario 03 +--- + ##Mandatory## The linking mechanism shall be structured such that each article may be linked to multiple incidents, and each incident may link to multiple articles. These links shall be implemented in such a way to be available to other processes - e.g. reporting, search, ranking algorithms, search results display. (In other words, as an example, a link embedded in an unstructured text field as part of an incident note would generally not satisfy this requirement.) @@ -28,10 +36,3 @@ Scenario 3 ##Documentation## - ---- -tags: - - Reuse - - Linking - - Many-to-Many Relationship Between Incidents and Articles ---- \ No newline at end of file diff --git a/docs/reuse/05.md b/docs/reuse/05.md index 0debdea..e3ad519 100644 --- a/docs/reuse/05.md +++ b/docs/reuse/05.md @@ -1,3 +1,11 @@ +--- +tags: + - Reuse + - Linking + - Linking to an existing KCS Article + - Scenario 03 +--- + ##Mandatory## Links shall be capable of being deleted by the analyst. @@ -28,10 +36,3 @@ Scenario 3 ##Documentation## - ---- -tags: - - Reuse - - Linking - - Linking to an existing KCS Article ---- \ No newline at end of file diff --git a/docs/reuse/06.md b/docs/reuse/06.md index 4a9fd78..bc1b12e 100644 --- a/docs/reuse/06.md +++ b/docs/reuse/06.md @@ -1,3 +1,12 @@ +--- +tags: + - Reuse + - Linking + - Referencing and Linking to Other Information Sources + - Not Mandatory + - Scenario 09 +--- + ##Not Mandatory## Linking incident to other types of content that solve the issue. These links shall be implemented in such a way to be available to other processes - e.g. reporting, search, ranking algorithms, search results display. Enables more than KCS articles counted in reuse counts, link rates and known vs new. @@ -28,10 +37,3 @@ Scenario 9 ##Documentation## - ---- -tags: - - Reuse - - Linking - - Referencing and Linking to Other Information Sources ---- \ No newline at end of file diff --git a/docs/reuse/07.md b/docs/reuse/07.md index 0744c3e..8cb5b9f 100644 --- a/docs/reuse/07.md +++ b/docs/reuse/07.md @@ -1,3 +1,11 @@ +--- +tags: + - Reuse + - Linking + - Managing Article Versions + - Scenario 10 +--- + ##Mandatory## The linking mechanism shall allow the analyst viewing the incident to see both the current version of any linked KCS article and the version of the article at the time it was delivered to the customer in the incident workflow. @@ -28,10 +36,3 @@ Scenario 10 ##Documentation## - ---- -tags: - - Reuse - - Linking - - Managing Article Versions ---- \ No newline at end of file diff --git a/docs/scenario/01.md b/docs/scenario/01.md new file mode 100644 index 0000000..a345d05 --- /dev/null +++ b/docs/scenario/01.md @@ -0,0 +1,24 @@ +--- +tags: + - Scenario 01 +--- + +#Scenario 1: External Self-Service to Incident - New Article# + +| Scenario 1: External Self-Service to Incident - New Article | Comments | Complete | +|-------------------------------------------------------------|----------|----------| +|Go to self-service portal | | | +|Capture requestor issue | | | +|Launch a search using all relevant information +|Display results from multiple content repositories (optional) +|View offered KCS article and one other content source (optional) +|Create incident/opportunity from self-service portal. The included environment information (optional), issue, and viewed content are preserved and automatically populated. +|Login as KCS Publisher (Responder) +|Responder opens incident, refines, and searches again +|Display results from multiple content repositories (optional) +|Issue not resolved +|KCS Publisher creates new KCS article by selecting an article template type. The environment information (optional), and issue are automatically populated in the KCS article template.The statements template shall include and not be alterable by the user: \* Issue\* Environment\* Resolution\* Cause\* Comments or feedback +|Demonstrate that the KCS article supports and retains basic formatting including preservation of line breaks, and that there is no arbitrary limit to the length of template sections. bullets and numbered lists in the resolution field. Insert a hyperlink to another related article. +|Search using entire contents of article to check for duplicates +|Set a statement or section as internal only audience +|KCS Publisher should have the option to select field settings. Set: \* Article Confidence to Validated\* Article Audience to External\* Article Governance to Compliance Based diff --git a/docs/scenario/02.md b/docs/scenario/02.md new file mode 100644 index 0000000..aac9223 --- /dev/null +++ b/docs/scenario/02.md @@ -0,0 +1,24 @@ +--- +tags: + - Scenario 02 +--- + +#Scenario 2: External Self-Service - Reuse Article. Add and Process Feedback# + +| Scenario 2: External Self-Service - Reuse Article, Add and Process Feedback | Comments | Complete | +|-------------------------------------------------------------------------------|----------|----------| +|Go to self-service portal +|Capture requestor issue and environment information +|Launch a search using all relevant information +|Display results from multiple content repositories +|Show reuse indicator on KCS articles +|Open KCS article +|Add comment or feedback on the KCS article +|Demonstrate reputation feedback button +|Log in as a KCS Publisher +|Find article with feedback by using queue for flag +|Edit article to incorporate feedback +|Reset status of article to published +|Show version history of article +|Show feedback history, turnaround time +|Show how feedback gets reported back to the requestor who submitted it \ No newline at end of file diff --git a/docs/scenario/03.md b/docs/scenario/03.md new file mode 100644 index 0000000..3e9500f --- /dev/null +++ b/docs/scenario/03.md @@ -0,0 +1,19 @@ +--- +tags: + - Scenario 03 +--- + +#Scenario 3: Internal Reuse with Incident# + +| Scenario 3: Internal Reuse with Incident | Comments | Complete | +|-------------------------------------------------------------|----------|----------| +|Go to internal incident management tool. Login as KCS Contributor +|Capture requestor issue and environment information +|Launch a search using all relevant information +|Display results from multiple content repositories +|Show reuse indicator +|Open KCS article +|Link KCS article to the incident +|Show linking indicator on incident and on KCS article +|Unlink the KCS article from the incident +|Show metadata and history of KCS article diff --git a/docs/scenario/04.md b/docs/scenario/04.md new file mode 100644 index 0000000..dc40289 --- /dev/null +++ b/docs/scenario/04.md @@ -0,0 +1,19 @@ +--- +tags: + - Scenario 04 +--- + +#Scenario 4: Internal Fix-it with Incident# + +| Scenario 4: Internal Fix-it with Incident | Comments | Complete | +|-------------------------------------------------------------|----------|----------| +|Go to internal incident management tool. Login as KCS Contributor +|Capture requestor issue and environment information +|Launch a search using all relevant information +|Display results from multiple content repositories +|Edit KCS article +|Updates KCS article to add additional information from issue description +|Set: +|Article Confidence to Validated +|Article Audience to Internal +|Article Governance to Experience Based \ No newline at end of file diff --git a/docs/scenario/05.md b/docs/scenario/05.md new file mode 100644 index 0000000..229e29d --- /dev/null +++ b/docs/scenario/05.md @@ -0,0 +1,20 @@ +--- +tags: + - Scenario 05 +--- + +#Scenario 5: KCS Candidate Creates Article with Incident, Check for Duplicates# + +| Scenario 5: KCS Candidate Creates Article with Incident, Check for Duplicates | Comments | Complete | +|--------------------------------------------------------------------------------|----------|----------| +|Go to internal incident management tool. Login as KCS Candidate +|Capture requestor issue and environment information +|Launch a search using all relevant information +|Display results from multiple content repositories +|Create KCS article +|Update KCS article to add additional information from issue description +|Search again using entire contents of the KCS article in order to find potential duplicates +|Set: +|Article Confidence to WIP (Validated not an option) +|Article Audience to Internal (External not an option) +|Article Governance to Experienced Based diff --git a/docs/scenario/06.md b/docs/scenario/06.md new file mode 100644 index 0000000..2169f57 --- /dev/null +++ b/docs/scenario/06.md @@ -0,0 +1,11 @@ +--- +tags: + - Scenario 06 +--- + +#Scenario 6: Report and Merge Duplicates# + +| Scenario 6: Report and Merge Duplicates | Comments | Complete | +|-------------------------------------------------------------|----------|----------| +|Log into KM tool as KDE +|Demonstrate mechanism to find and merge duplicate articles diff --git a/docs/scenario/07.md b/docs/scenario/07.md new file mode 100644 index 0000000..1e49e93 --- /dev/null +++ b/docs/scenario/07.md @@ -0,0 +1,29 @@ +--- +tags: + - Scenario 07 +--- + +#Scenario 7: Administration# + +| Scenario 7: Administration | Comments | Complete | +|-------------------------------------------------------------|----------|----------| +|Log in as administrator +|Create new user +|Add to user groups +|Show privileges +|Show mechanism to configure article templates +|Demonstrate logic to implement business rules by user role (KCS Candidate, KCS Contributor, KCS Publisher) for Article Confidence, Article Audience, and Article Governance. +|KCS Candidate can set: +|• Article Confidence to WIP and Not Validated +|• Article Audience to Internal only +|• Article Governance to Experience Based only +|KCS Contributor can set: +|• Article Confidence to WIP, Not Validated, Validated, or Archive +|• Article Audience to Internal only +|• Article Governance to Experience Based only +|KCS Publisher can set: +|• Article Confidence to WIP, Not Validated, Validated, or Archive +|• Article Audience to Internal if WIP or Not Validated. External if Validated +|• Article Governance to Experience or Compliance based +|Show mechanism to configure automated publication of articles. (90 minutes for indexing) +|Show interface provided for search tuning diff --git a/docs/scenario/08.md b/docs/scenario/08.md new file mode 100644 index 0000000..2e3228e --- /dev/null +++ b/docs/scenario/08.md @@ -0,0 +1,10 @@ +--- +tags: + - Scenario 08 +--- + +#Scenario 8: Reports# + +| Scenario 8: Reports | Comments | Complete | +|-------------------------------------------------------------|----------|----------| +|Show reporting capabilities. Must show and deliver copies of all the reports from the Self-Assessment worksheets (Performance Assessment Worksheet) \ No newline at end of file diff --git a/docs/scenario/09.md b/docs/scenario/09.md new file mode 100644 index 0000000..133b961 --- /dev/null +++ b/docs/scenario/09.md @@ -0,0 +1,17 @@ +--- +tags: + - Scenario 09 +--- + +#Scenario 9: Unique ID System of Record to Assisted - New Article# + +| Scenario 9: Unique ID System of Record to Assisted - New Article | Comments | Complete | +|------------------------------------------------------------------|----------|----------| +|Login as an assisted responder with KCS Contributor rights +|Responder captures requestor’s inquiry from a channel of assistance other than an incident, can be a sales opportunity, chat inquiry, statement of work, HR inquiry etc. Responder populates search. +|Responder launches a search using all relevant information from inquiry +|View offered KCS article +|Responder refines and searches again +|Responder creates new KCS article. The environment information (optional), and issue is automatically populated in the KCS article template. The statements template shall include: • Issue • Environment • Resolution • Cause • Comments or feedback +|Responder sets • Article Confidence to WIP (all confidence levels should show up in pick list) • Article Audience to Internal • Article Governance to Experienced Based +|Set a system of record field in the KCS article that can be used to report on where the requestor’s unique system id of inquiry originated (sales opportunity id, chat inquiry hyperlink, statement of work, HR inquiry etc.) \ No newline at end of file diff --git a/docs/scenario/10.md b/docs/scenario/10.md new file mode 100644 index 0000000..254cbfe --- /dev/null +++ b/docs/scenario/10.md @@ -0,0 +1,22 @@ +--- +tags: + - Scenario 10 +--- + +#Scenario 10: External Self-Service No ID System of Record Explicit Reuse Article# + +| Scenario 10: External Self-Service No ID System of Record Explicit Reuse Article | Comments | Complete | +|----------------------------------------------------------------------------------|----------|----------| +|Go to self-service portal +|Capture requestor issue and environment information +|Launch a search using all relevant information +|Display results from multiple content repositories +|Show reuse or relevance indicator on KCS articles +|Open KCS article +|Demonstrate explicit reputation, this helped button, star rating, or thumbs up. Only one required. +|Leave feedback in written feedback field +|Log in as a KCS Publisher +|Find article that just received feedback +|Show explicit feedback/reuse counter on article +|Show page views on article +|Show version history of article diff --git a/docs/scenario/11.md b/docs/scenario/11.md new file mode 100644 index 0000000..f33db4d --- /dev/null +++ b/docs/scenario/11.md @@ -0,0 +1,20 @@ +--- +tags: + - Scenario 11 +--- + +#Scenario 11: External Self-Service, No ID System of Record Search Behaviors, Log of Search Strings and Click Streams on Articles# + +| Scenario 11: External Self-Service, No ID System of Record Search Behaviors, Log of Search Strings and Click Streams on Articles | Comments | Complete | +|-------------------------------------------------------------|----------|----------| +|Login to external self-service portal as a requestor +|Capture customer issue and environment information +|Launch a search using all relevant information +|Display results from multiple content repositories +|Open KCS article +|Search again +|Open and print KCS article +|Search again +|Open different KCS article +|Close browser or window +|Show Search behavior/log of search strings and click stream (may require integration) diff --git a/docs/structure/01.md b/docs/structure/01.md index 3dd764e..1fd3be1 100644 --- a/docs/structure/01.md +++ b/docs/structure/01.md @@ -1,6 +1,14 @@ +--- +tags: + - Structure + - Utilize Simple Templates + - Scenario 01 +--- + ##Mandatory## A KCS article template that includes the following fields: + * Issue * Environment * Resolution @@ -32,10 +40,3 @@ Scenario 1 ##Documentation## - - ---- -tags: - - Structure - - Utilize Simple Templates ---- \ No newline at end of file diff --git a/docs/structure/02.md b/docs/structure/02.md index 36167f7..84ffd67 100644 --- a/docs/structure/02.md +++ b/docs/structure/02.md @@ -1,3 +1,10 @@ +--- +tags: + - Structure + - Utilize Simple Templates + - Scenario 01 +--- + ##Mandatory## Issue can be captured in the workflow in a template that helps to structure the content. @@ -27,10 +34,3 @@ Scenario 1 ##Documentation## - - ---- -tags: - - Structure - - Utilize Simple Templates ---- \ No newline at end of file diff --git a/docs/structure/03.md b/docs/structure/03.md index e63c7fc..e070efc 100644 --- a/docs/structure/03.md +++ b/docs/structure/03.md @@ -1,3 +1,11 @@ +--- +tags: + - Structure + - Utilize Simple Templates + - Not Mandatory + - Scenario 01 +--- + ##Not Mandatory## Template structure of the Article is not alterable by the user when creating or editing an article @@ -28,10 +36,3 @@ Scenario 1 ##Documentation## - - ---- -tags: - - Structure - - Utilize Simple Templates ---- \ No newline at end of file diff --git a/docs/structure/04.md b/docs/structure/04.md index 174c082..7fbfc7d 100644 --- a/docs/structure/04.md +++ b/docs/structure/04.md @@ -1,3 +1,10 @@ +--- +tags: + - Structure + - Utilize Simple Templates + - Scenario 07 +--- + ##Mandatory## Administrators may specify or adjust which fields are being present in any given template and multiple templates may be maintained. @@ -27,10 +34,3 @@ Scenario 7 ##Documentation## - - ---- -tags: - - Structure - - Utilize Simple Templates ---- \ No newline at end of file diff --git a/docs/structure/05.md b/docs/structure/05.md index abc711e..38b9e0e 100644 --- a/docs/structure/05.md +++ b/docs/structure/05.md @@ -1,3 +1,10 @@ +--- +tags: + - Structure + - Utilize Simple Templates + - Scenario 07 +--- + ##Mandatory## At KCS Article capture, user may select which template they use, although a default may be maintained. @@ -27,9 +34,3 @@ Scenario 7 ##Documentation## - ---- -tags: - - Structure - - Utilize Simple Templates ---- \ No newline at end of file diff --git a/docs/structure/06.md b/docs/structure/06.md index 91c89a3..d2be605 100644 --- a/docs/structure/06.md +++ b/docs/structure/06.md @@ -1,3 +1,10 @@ +--- +tags: + - Structure + - Details on the Resolution Field + - Not Mandatory +--- + ##Not Mandatory## Visibility of content can be managed at the field level of the article based on the role and/or entitlement of the person looking at the article @@ -27,9 +34,3 @@ Technique 5.1: KCS Article Structure ##Documentation## - ---- -tags: - - Structure - - Details on the Resolution Field ---- \ No newline at end of file diff --git a/docs/structure/07.md b/docs/structure/07.md index 8d8782a..cc4e50b 100644 --- a/docs/structure/07.md +++ b/docs/structure/07.md @@ -1,3 +1,10 @@ +--- +tags: + - Structure + - Complete Thoughts, Not Complete Sentences + - Scenario 01 +--- + ##Mandatory## Captured KCS Article content from initial entry will support at least basic formatting, including preservation of breaks. No arbitrary limit on the length of template sections will be imposed. @@ -27,9 +34,3 @@ Scenario 1 ##Documentation## - ---- -tags: - - Structure - - Complete Thoughts, Not Complete Sentences ---- \ No newline at end of file diff --git a/docs/structure/08.md b/docs/structure/08.md index ce5944a..bf3bc3a 100644 --- a/docs/structure/08.md +++ b/docs/structure/08.md @@ -1,3 +1,10 @@ +--- +tags: + - Structure + - Complete Thoughts, Not Complete Sentences + - Scenario 01 +--- + ##Mandatory## KCS Articles can be entered and edited as bullet lists and numbered lists. @@ -27,9 +34,3 @@ Scenario 1 ##Documentation## - ---- -tags: - - Structure - - Complete Thoughts, Not Complete Sentences ---- \ No newline at end of file diff --git a/docs/structure/09.md b/docs/structure/09.md index 39af782..ccdffd6 100644 --- a/docs/structure/09.md +++ b/docs/structure/09.md @@ -1,3 +1,11 @@ +--- +tags: + - Reuse + - Linking + - Referencing and Linking to Other Information Sources + - Scenario 01 +--- + ##Mandatory## KCS articles can have embedded hyperlinks to other sources of content, such as KCS articles, or content addressable by a URL. @@ -28,10 +36,3 @@ Scenario 1 ##Documentation## - ---- -tags: - - Reuse - - Linking - - Referencing and Linking to Other Information Sources ---- \ No newline at end of file diff --git a/docs/structure/10.md b/docs/structure/10.md index 3c2fcf6..966ddd7 100644 --- a/docs/structure/10.md +++ b/docs/structure/10.md @@ -1,3 +1,9 @@ +--- +tags: + - Content Health + - Global Support Considerations +--- + ##Mandatory## Describe your strategy for supporting locale-specific or multilingual content, including support for translation workflow or machine translation. List supported languages and restrictions associated with specific languages, if any. Example: Include double-byte languages and right-to-left languages. Is a master-slave relationship between translated documents supported? Must there be a single master language, or can content in any language be the"master" for a given article. @@ -27,9 +33,3 @@ Describe your strategy for supporting locale-specific or multilingual content, i ##Documentation## - ---- -tags: - - Content Health - - Global Support Considerations ---- \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 872d9e1..64741f2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,3 +1,4 @@ + site_name: Open Knowledge theme: name: material @@ -11,90 +12,102 @@ theme: nav: - Home: index.md + - Scenarios: + - 'Scenario 01': 'scenario/01.md' + - 'Scenario 02': 'scenario/02.md' + - 'Scenario 03': 'scenario/03.md' + - 'Scenario 04': 'scenario/04.md' + - 'Scenario 05': 'scenario/05.md' + - 'Scenario 06': 'scenario/06.md' + - 'Scenario 07': 'scenario/07.md' + - 'Scenario 08': 'scenario/08.md' + - 'Scenario 09': 'scenario/09.md' + - 'Scenario 10': 'scenario/10.md' + - 'Scenario 11': 'scenario/11.md' + - Capture: - - Integration: capture/01 integration.md - - Context: capture/02 context.md - - Relevant: capture/03 relevant.md + - 'Capture - Integration': capture/01.md + - 'Capture - Context': capture/02.md + - 'Capture - Relevant': capture/03.md - Structure: - - '01': structure/01.md - - '02': structure/02.md - - '03': structure/03.md - - '04': structure/04.md - - '05': structure/05.md - - '06': structure/06.md - - '07': structure/07.md - - '08': structure/08.md - - '09': structure/09.md - - '10': structure/10.md + - 'Structure 01': structure/01.md + - 'Structure 02': structure/02.md + - 'Structure 03': structure/03.md + - 'Structure 04': structure/04.md + - 'Structure 05': structure/05.md + - 'Structure 06': structure/06.md + - 'Structure 07': structure/07.md + - 'Structure 08': structure/08.md + - 'Structure 09': structure/09.md + - 'Structure 10': structure/10.md - Reuse: - - '01': reuse/01.md - - '02': reuse/02.md - - '03': reuse/03.md - - '04': reuse/04.md - - '05': reuse/05.md - - '06': reuse/06.md - - '07': reuse/07.md + - 'Reuse 01': reuse/01.md + - 'Reuse 02': reuse/02.md + - 'Reuse 03': reuse/03.md + - 'Reuse 04': reuse/04.md + - 'Reuse 05': reuse/05.md + - 'Reuse 06': reuse/06.md + - 'Reuse 07': reuse/07.md - Improve: - - '01': improve/01.md - - '02': improve/02.md - - '03': improve/03.md - - '04': improve/04.md - - '05': improve/05.md - - '06': improve/06.md + - 'Improve 01': improve/01.md + - 'Improve 02': improve/02.md + - 'Improve 03': improve/03.md + - 'Improve 04': improve/04.md + - 'Improve 05': improve/05.md + - 'Improve 06': improve/06.md - Content Health: - - '01': content health/01.md - - '02': content health/02.md - - '03': content health/03.md - - '04': content health/04.md - - '05': content health/05.md - - '06': content health/06.md - - '07': content health/07.md - - '08': content health/08.md - - '09': content health/09.md - - '10': content health/10.md - - '11': content health/11.md - - '12': content health/12.md - - '13': content health/13.md - - '14': content health/14.md + - 'Content Health 01': content health/01.md + - 'Content Health 02': content health/02.md + - 'Content Health 03': content health/03.md + - 'Content Health 04': content health/04.md + - 'Content Health 05': content health/05.md + - 'Content Health 06': content health/06.md + - 'Content Health 07': content health/07.md + - 'Content Health 08': content health/08.md + - 'Content Health 09': content health/09.md + - 'Content Health 10': content health/10.md + - 'Content Health 11': content health/11.md + - 'Content Health 12': content health/12.md + - 'Content Health 13': content health/13.md - Process Integration: - - '01': process integration/01.md - - '02': process integration/02.md - - '03': process integration/03.md - - '04': process integration/04.md - - '05': process integration/05.md - - '06': process integration/06.md - - '07': process integration/07.md - - '08': process integration/08.md - - '09': process integration/09.md - - '10': process integration/10.md - - '11': process integration/11.md + - 'Process Integration 01': process integration/01.md + - 'Process Integration 02': process integration/02.md + - 'Process Integration 03': process integration/03.md + - 'Process Integration 04': process integration/04.md + - 'Process Integration 05': process integration/05.md + - 'Process Integration 06': process integration/06.md + - 'Process Integration 07': process integration/07.md + - 'Process Integration 08': process integration/08.md + - 'Process Integration 09': process integration/09.md + - 'Process Integration 10': process integration/10.md + - 'Process Integration 11': process integration/11.md - Performance Assessment: - - '01': performance assessment/01.md - - '02': performance assessment/02.md - - '03': performance assessment/03.md - - '04': performance assessment/04.md - - '05': performance assessment/05.md - - '06': performance assessment/06.md - - '07': performance assessment/07.md - - '08': performance assessment/08.md - - '09': performance assessment/09.md - - '10': performance assessment/10.md - - '11': performance assessment/11.md - - '12': performance assessment/12.md - - '13': performance assessment/13.md - - '14': performance assessment/14.md - - '15': performance assessment/15.md - - '16': performance assessment/16.md - - '17': performance assessment/17.md - - '18': performance assessment/18.md - - '19': performance assessment/19.md - - '20': performance assessment/20.md - - '21': performance assessment/21.md - - '22': performance assessment/22.md - - '23': performance assessment/23.md - - '24': performance assessment/24.md - - '25': performance assessment/25.md - - '26': performance assessment/26.md + - 'Performance Assessment 01': performance assessment/01.md + - 'Performance Assessment 02': performance assessment/02.md + - 'Performance Assessment 03': performance assessment/03.md + - 'Performance Assessment 04': performance assessment/04.md + - 'Performance Assessment 05': performance assessment/05.md + - 'Performance Assessment 06': performance assessment/06.md + - 'Performance Assessment 07': performance assessment/07.md + - 'Performance Assessment 08': performance assessment/08.md + - 'Performance Assessment 09': performance assessment/09.md + - 'Performance Assessment 10': performance assessment/10.md + - 'Performance Assessment 11': performance assessment/11.md + - 'Performance Assessment 12': performance assessment/12.md + - 'Performance Assessment 13': performance assessment/13.md + - 'Performance Assessment 14': performance assessment/14.md + - 'Performance Assessment 15': performance assessment/15.md + - 'Performance Assessment 16': performance assessment/16.md + - 'Performance Assessment 17': performance assessment/17.md + - 'Performance Assessment 18': performance assessment/18.md + - 'Performance Assessment 19': performance assessment/19.md + - 'Performance Assessment 20': performance assessment/20.md + - 'Performance Assessment 21': performance assessment/21.md + - 'Performance Assessment 22': performance assessment/22.md + - 'Performance Assessment 23': performance assessment/23.md + - 'Performance Assessment 24': performance assessment/24.md + - 'Performance Assessment 25': performance assessment/25.md + - 'Performance Assessment 26': performance assessment/26.md - Tags: tags.md @@ -107,7 +120,7 @@ plugins: repo_url: https://git.drupalcode.org/project/open_knowledge copyright: Copyright © 2020 - 2025 Steven Ayers<br/>KCS® is a service mark of the Consortium for Service InnovationTM. Open Knowledge is not certified by the Consortium for Service Innovation. extra: - generator: true + generator: false social: - icon: fontawesome/brands/gitlab link: https://git.drupalcode.org/project/open_knowledge \ No newline at end of file -- GitLab