diff --git a/composer.json b/composer.json index c818429704607db25a7b39a0fc0503cb99d85bc1..e5414884400234b0a7d093eff317c5816d30bbfc 100644 --- a/composer.json +++ b/composer.json @@ -42,6 +42,7 @@ "drupal/search_api_page": "^1.0", "drupal/search_api_solr": "^4.3", "drupal/sitemap": "^2.0@beta", + "drupal/tmgmt": "^1", "drupal/visitors": "^2.0" }, "config": { diff --git a/docs/capture/01.md b/docs/capture/01.md index 42d3a623f156ccd0964934ba605800f880d8e9bd..384fbbdd0c294bb2c8b9d8e329c42033951abe3c 100644 --- a/docs/capture/01.md +++ b/docs/capture/01.md @@ -4,8 +4,12 @@ tags: - Seamless Technology Integration - Integration with Web Portals and Online Processes - Scenario 01 + - 'Technique 6.5: KCS Process Integration Indicators' + - ❌ --- +Status: Incomplete ❌ + ##Mandatory## Seamless, logical transition for a user searching on web portal. Ability to initiate a search and present results before or after the incident creation. The content of search strings and documents reviewed are preserved and automatically populated in the incident or article. @@ -23,7 +27,7 @@ Seamless, logical transition for a user searching on web portal. Ability to ini ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/capture/02.md b/docs/capture/02.md index 618f0ab174fccf2065e910e71522736c9a898827..15dc0fbea40045f00dc8b6b8b7621e69e30b93ea 100644 --- a/docs/capture/02.md +++ b/docs/capture/02.md @@ -3,8 +3,12 @@ tags: - Capture - Capture the Requestor's Context - Scenario 01 + - "Technique 1.2 Capture the Requestor's Context" + - ❌ --- +Status: Incomplete ❌ + ##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. @@ -19,7 +23,7 @@ As the issue is being solved information can be captured in the requestor's cont [Technique 1.2 Capture the Requestor's Context](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/010/020) ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/capture/03.md b/docs/capture/03.md index 1312b8f3deb751c1aa37df29811ff78d74d2fca1..80faa171e8297e21fc30ac2dfa78cf3697f67fed 100644 --- a/docs/capture/03.md +++ b/docs/capture/03.md @@ -3,8 +3,12 @@ tags: - Capture - Capture Relevant Content - Scenario 01 + - "Technique 1.2 Capture the Requestor's Context" + - ❌ --- +Status: Incomplete ❌ + ##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.) @@ -20,7 +24,7 @@ Preserved information can be edited or re-purposed into a KCS article. Searches [Technique 1.2 Capture the Requestor's Context](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/010/020) ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## @@ -35,3 +39,5 @@ Scenario 1 ##Documentation## + +Search API module allows for refining the search. [Facets](https://www.drupal.org/project/facets) module allows for drilling down by taxonomy, etc. diff --git a/docs/content health/01.md b/docs/content health/01.md index b98fce231a668f3e21ec3d663d82e7530b551bc3..7e4eef19464189a4fd733e60fd2d9e61d23c42e0 100644 --- a/docs/content health/01.md +++ b/docs/content health/01.md @@ -3,8 +3,12 @@ tags: - Content Health - The KCS Article State - Scenario 03 + - 'Technique 5.1: KCS Article Structure' + - ❓ --- +Status: Unknown ❓ + ##Mandatory## For each KCS article, the system shall record: @@ -26,7 +30,7 @@ Article governance change date/time and ID [Technique 5.1: KCS Article Structure](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/040/010/020) ##Demo Requirements for Verified Only## -Scenario 3 +[Scenario 03](../scenario/03.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/content health/02.md b/docs/content health/02.md index 6dafd75d63b6bd42edd268d15f8770418bfcb56f..8bab5f2d8d2b01e27b0ed023ca3993b102db961e 100644 --- a/docs/content health/02.md +++ b/docs/content health/02.md @@ -3,8 +3,11 @@ tags: - Reuse - Linking - Scenario 03 + - ❓ --- +Status: Unknown ❓ + ##Mandatory## For each KCS article, the system shall record for an identified audience(internal vs external), date, role @@ -23,7 +26,7 @@ Page views ##Demo Requirements for Verified Only## -Scenario 3 +[Scenario 03](../scenario/03.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/content health/03.md b/docs/content health/03.md index b166ac0173e6338ff777f9bac89b6f0f66b95eb5..73d3c5ddb89920862f8796116b01d100cb6b4531 100644 --- a/docs/content health/03.md +++ b/docs/content health/03.md @@ -3,8 +3,12 @@ tags: - Content Health - The KCS Article State - Scenario 01 + - 'Technique 5.1: KCS Article Structure' + - ❓ --- +Status: Unknown ❓ + ##Mandatory## The system shall support content being in a minimum of four article confidence levels: @@ -25,7 +29,7 @@ Archive [Technique 5.1: KCS Article Structure](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/040/010/020) ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/content health/04.md b/docs/content health/04.md index 70cdf8bf1fd820d7d08a99c54a7bc0a1f836359c..31e5b1425849457f045c781153760f654fa63d6b 100644 --- a/docs/content health/04.md +++ b/docs/content health/04.md @@ -4,8 +4,12 @@ tags: - The KCS Article State - Article Visibility Who Gets to See What - Scenario 07 + - 'Technique 5.1: KCS Article Structure' + - ❓ --- +Status: Unknown ❓ + ##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. @@ -23,7 +27,7 @@ Articles in each confidence level WIP, Not Validated, Validated, Archive, shall [Technique 5.1: KCS Article Structure](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/040/010/020) ##Demo Requirements for Verified Only## -Scenario 7 +[Scenario 07](../scenario/07.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/content health/05.md b/docs/content health/05.md index 9bd6729c874457a3d218809e3a97f691f74bfe0a..ad5372db9a0aff4928b5df164c32fe201508d7ee 100644 --- a/docs/content health/05.md +++ b/docs/content health/05.md @@ -4,8 +4,12 @@ tags: - Assessing the Value of Articles - Article value based on reuse - Not Mandatory + - 'Technique 5.10: Content Health Indicators' + - ❎ --- +Status: 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. diff --git a/docs/content health/06.md b/docs/content health/06.md index e5a56fe41739fb8cb5ed0d2e1d1ae290501ddc51..1f92e9a29cd6daac12cfc6392682e1c9eebe17aa 100644 --- a/docs/content health/06.md +++ b/docs/content health/06.md @@ -4,8 +4,12 @@ tags: - Self-Service Measures - Integrating Feedback - Scenario 02 + - 'Technique 5.12: Self-Service Measures' + - ❓ --- +Status: Unknown ❓ + ##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. @@ -25,7 +29,7 @@ Technique 5.12: Self-Service Measures ##Demo Requirements for Verified Only## -Scenario 2 +[Scenario 02](../scenario/02.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/content health/07.md b/docs/content health/07.md index a799848a9654220832f83942ef6cb08d5c128458..9f535664fdefa7b3e3c9c03ff5c62bd4203d191e 100644 --- a/docs/content health/07.md +++ b/docs/content health/07.md @@ -4,8 +4,12 @@ tags: - Self-service Success - Not Mandatory - Scenario 07 + - 'Technique 5.11: Self-Service Success' + - ❓ --- +Status: Unknown ❓ + ##Not Mandatory## Mechanism to configure rules to automatically publish KCS articles. @@ -20,7 +24,7 @@ Mechanism to configure rules to automatically publish KCS articles. Technique 5.11: Self-Service Success ##Demo Requirements for Verified Only## -Scenario 7 +[Scenario 07](../scenario/07.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/content health/08.md b/docs/content health/08.md index 4a71ab412b304454cf09900f8987c5baa4755d67..caf5a0a27610822d7c1ea4d3456b41146f4dc73b 100644 --- a/docs/content health/08.md +++ b/docs/content health/08.md @@ -1,8 +1,11 @@ --- tags: - Not Mandatory + - ❓ --- +Status: Unknown ❓ + ##Not Mandatory## Enable a configuration that allows an external audience or end users in the community to reuse, create, and modify KCS articles diff --git a/docs/content health/09.md b/docs/content health/09.md index 8be84a6e046d79513eb4e41560fb16a76dab01aa..d31ddd7026966ca1d0cf83c753f580fafc26dbb4 100644 --- a/docs/content health/09.md +++ b/docs/content health/09.md @@ -1,3 +1,9 @@ +--- +tags: + - ❓ +--- + +Status: Unknown ❓ ##Mandatory## diff --git a/docs/content health/10.md b/docs/content health/10.md index f8f5c910977efe5e34f5cf7994e9c08c57b89e06..a02e7495eced8351acf42f62c4ed4ba1b354d9b1 100644 --- a/docs/content health/10.md +++ b/docs/content health/10.md @@ -1,3 +1,10 @@ +--- +tags: + - 'Technique 5.11: Self-Service Success' + - ❓ +--- + +Status: Unknown ❓ ##Mandatory## diff --git a/docs/content health/11.md b/docs/content health/11.md index 37e7d2b4c1e0df226f2d9b1ebc4314dc01433dd3..c9b9e0885e18a3abff47e0f0cc7fdf5895e1e50a 100644 --- a/docs/content health/11.md +++ b/docs/content health/11.md @@ -1,8 +1,12 @@ --- tags: - Not Mandatory + - 'Technique 5.11: Self-Service Success' + - ❓ --- +Status: Unknown ❓ + ##Not Mandatory## Navigation in self-service mechanism aligns to the requestor's intent diff --git a/docs/content health/12.md b/docs/content health/12.md index 2f455d4d22829812fbe93bb016115d71d5daca0d..2bbaa8c7c757e69a67d12b1b531853d667084240 100644 --- a/docs/content health/12.md +++ b/docs/content health/12.md @@ -1,4 +1,10 @@ +--- +tags: + - 'Technique 5.11: Self-Service Success' + - ❓ +--- +Status: Unknown ❓ ##Mandatory## diff --git a/docs/content health/13.md b/docs/content health/13.md index 87413ad2a8e906f740c24404c18c02695368f62c..9097f8a3d638b4e4cc38d603753d432a65965f25 100644 --- a/docs/content health/13.md +++ b/docs/content health/13.md @@ -1,4 +1,10 @@ +--- +tags: + - 'Technique 5.11: Self-Service Success' + - ❓ +--- +Status: Unknown ❓ ##Mandatory## diff --git a/docs/improve/01.md b/docs/improve/01.md index 2b83375a03855dd3d63b268fa604ccf83680dd3c..24d5e2392877fc26f7d4a4b9561d4d7fd861e10c 100644 --- a/docs/improve/01.md +++ b/docs/improve/01.md @@ -3,8 +3,12 @@ tags: - Improve - Flag it or Fix it - Scenario 02 + - 'Technique 4.2: Flag It or Fix It' + - ✅ --- +Status: Complete ✅ + ##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. @@ -19,10 +23,11 @@ The system shall support a KCS Candidate finding and flagging content that needs [Technique 4.2: Flag It or Fix It](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/040/030) ##Demo Requirements for Verified Only## -Scenario 2 +[Scenario 02](../scenario/02.md) ##OB/Config/Cust/NS/SF## - +###Out of the Box### +We use the Moderation Notes community module. ##Native Product Capability## diff --git a/docs/improve/02.md b/docs/improve/02.md index 08a0fa33a9507441a87fbe6ed6d0f2a05a894f2c..563873e7ebc322702dd02a5655370a71fd7f7714 100644 --- a/docs/improve/02.md +++ b/docs/improve/02.md @@ -4,8 +4,12 @@ tags: - Flag it or Fix it - License to Modify - Scenario 02 + - 'KCS Roles and the Licensing Model' + - ❓ --- +Status: Unknown ❓ + ##Mandatory## System shall support KCS Contributor finding and fixing KCS article immediately. @@ -22,7 +26,7 @@ System shall support KCS Contributor finding and fixing KCS article immediately. ##Demo Requirements for Verified Only## -Scenario 2 +[Scenario 02](../scenario/02.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/improve/03.md b/docs/improve/03.md index bb713d56098bad07edcd7a529962ff140938c10b..320c9b46f8005cb244044e15017919e00e18fc4c 100644 --- a/docs/improve/03.md +++ b/docs/improve/03.md @@ -3,8 +3,12 @@ tags: - Improve - Flag it or Fix it - Scenario 02 + - 'Technique 4.2: Flag It or Fix It' + - ❌ --- +Status: Incomplete ❌ + ##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. @@ -19,7 +23,7 @@ All users, including external self-service users, shall have the ability to prov [Technique 4.2: Flag It or Fix It](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/040/030) ##Demo Requirements for Verified Only## -Scenario 2 +[Scenario 02](../scenario/02.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/improve/04.md b/docs/improve/04.md index dbe3f909b00bce18400aa353674f4df41bcadb74..4b10ee0e3674d44e372059adc7ca8772a3ac7dc7 100644 --- a/docs/improve/04.md +++ b/docs/improve/04.md @@ -3,8 +3,12 @@ tags: - Improve - Duplicate Articles - Scenario 01 + - 'Technique 4.2: Dealing with Duplicates - The Merge' + - ❓ --- +Status: Unknown ❓ + ##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. @@ -19,7 +23,7 @@ During the course of knowledge capture, after the user has entered content into [Technique 4.2: Dealing with Duplicates - The Merge](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/040/030#Dealing_with_Duplicates:_The_Merge) ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/improve/05.md b/docs/improve/05.md index 705e20756a8173cd592f3ae03d816fa54cbcc433..dd96e4d347920a39ad297bfca302c2159443586d 100644 --- a/docs/improve/05.md +++ b/docs/improve/05.md @@ -4,8 +4,12 @@ tags: - Dealing with Duplicates - The Merge - Not Mandatory - Scenario 06 + - 'Technique 4.2: Dealing with Duplicates - The Merge' + - ❓ --- +Status: Unknown ❓ + ##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. @@ -20,7 +24,7 @@ System shall support a function to merge duplicates. Newer articles content and [Technique 4.2: Dealing with Duplicates - The Merge](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/040/030#Dealing_with_Duplicates:_The_Merge) ##Demo Requirements for Verified Only## -Scenario 6 +[Scenario 06](../scenario/06.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/improve/06.md b/docs/improve/06.md index c68856f8f2a79ebe9ca9a51c21bdbffa094cf9c3..f446ff5cc60f8c6de891453a3506c81a114a0f65 100644 --- a/docs/improve/06.md +++ b/docs/improve/06.md @@ -3,8 +3,12 @@ tags: - Improve - Dealing with Duplicates - The Merge - Scenario 06 + - 'Technique 4.2: Dealing with Duplicates - The Merge' + - ❓ --- +Status: Unknown ❓ + ##Mandatory## System shall support the ability to view and edit multiple articles simultaneously in order to merge duplicate articles by editing and changing state. @@ -20,7 +24,7 @@ System shall support the ability to view and edit multiple articles simultaneous ##Demo Requirements for Verified Only## -Scenario 6 +[Scenario 06](../scenario/06.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/index.md b/docs/index.md index fd93378c1970a4d68ad3caf745cc2518323d97ed..fd7163b212fdaf8dbc18a1758e57690543d740d9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,15 @@ -Open Knowledge, a powerful and versatile Drupal distribution designed to unlock the potential of collaborative learning and knowledge sharing. Built on the robust Drupal framework, Open Knowledge is a Knowledge-Centered Service (KCS®) knowledge-base +This is meant to track Open Knowledge's progress to being Verified. -✅ -❌ -❎ + +[KCS v6 Verified & Aligned Self-Assessment Worksheets](references.md) + +| Status | Emoji | Count | +|--------------------------------|:-----:|------:| +| [Complete](tags/#_1) | ✅ | 14 | +| [Incomplete](tags/#_2) | ❌ | 6 | +| [Not Mandatory](tags/#_3) | ❎ | 6 | +| [Unknown](tags/#_4) | ❓ | 50 | +| Total | | 76 | ##Definitions## diff --git a/docs/performance assessment/01.md b/docs/performance assessment/01.md index 55fac43f27c73fcc6094a3dda39f058134415026..4d7cb7bff7c7ea1afc503062aab375ce6b9342c6 100644 --- a/docs/performance assessment/01.md +++ b/docs/performance assessment/01.md @@ -4,8 +4,12 @@ tags: - Assessing the Creation of Value - Measures for Individuals and Teams - Scenario 09 + - 'Technique 7.3: Assessing the Creation of Value' + - ❓ --- +Status: Unknown ❓ + ##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), @@ -20,7 +24,7 @@ The system shall provide reports showing documents created, modified, and flagge Technique 7.3: Assessing the Creation of Value ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/02.md b/docs/performance assessment/02.md index 7194f085f8693a1adf8cb388545a4ffc1511b0ad..5353daf72b6dc74d6ffcbbd508f28c9683c3a520 100644 --- a/docs/performance assessment/02.md +++ b/docs/performance assessment/02.md @@ -3,8 +3,12 @@ tags: - Performance Assessment - Assessing the Creation of Value - Scenario 09 + - 'Technique 7.3: Assessing the Creation of Value' + - ❌ --- +Status: Incomplete ❌ + ##Mandatory## The system shall provide reports showing citation rates for an individual or team (group of users) and knowledge domain (category, tag, or node). @@ -18,7 +22,7 @@ The system shall provide reports showing citation rates for an individual or tea Technique 7.3: Assessing the Creation of Value ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/03.md b/docs/performance assessment/03.md index 9fda3f9ea3c6f790253434e2fa3a04cdec09ca05..eda1dc98d24c35233fd97725f89df23ade70e2a9 100644 --- a/docs/performance assessment/03.md +++ b/docs/performance assessment/03.md @@ -4,8 +4,12 @@ tags: - Assessing the Creation of Value - Link Rate as an Indicator - Scenario 09 + - 'Technique 7.3: Assessing the Creation of Value' + - ❓ --- +Status: Unknown ❓ + ##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). @@ -20,7 +24,7 @@ The system shall provide reports showing a link rate indicator for a particular Technique 7.3: Assessing the Creation of Value ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/04.md b/docs/performance assessment/04.md index 53cb5b2a4f51738aac80932f89a827adb5889ada..dd4f0a5d0f85cdeca99ce2c6a990899a2f8b15a7 100644 --- a/docs/performance assessment/04.md +++ b/docs/performance assessment/04.md @@ -4,8 +4,12 @@ tags: - Assessing the Creation of Value - KCS Article Life Cycle Trend - Scenario 09 + - 'Technique 7.3: Assessing the Creation of Value' + - ❓ --- +Status: Unknown ❓ + ##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.) @@ -20,7 +24,7 @@ The system shall provide reports showing the number of documents in each article Technique 7.3: Assessing the Creation of Value ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/05.md b/docs/performance assessment/05.md index b6bce42be93fba8218ffce7c35732610cf7a8092..cf0a70ab431e2c71e8ecd19f9fe6a495772abecb 100644 --- a/docs/performance assessment/05.md +++ b/docs/performance assessment/05.md @@ -4,8 +4,12 @@ tags: - Managing KCS Article Quality - The Article Quality Index - Scenario 09 + - 'Technique 5.10: Content Health Indicators' + - ❓ --- +Status: Unknown ❓ + ##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. @@ -20,7 +24,7 @@ The system shall provide reports/enables showing the Content Standard Checklist Technique 5.10: Content Health Indicators ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/06.md b/docs/performance assessment/06.md index c702b4e0f59152eb48bc16d7e6e10061da5bb0fb..6557d13c3a0ad2177e893ddc208b1d87df836e8a 100644 --- a/docs/performance assessment/06.md +++ b/docs/performance assessment/06.md @@ -3,8 +3,12 @@ tags: - Process Integration - KCS Process Integration Indicators - Scenario 09 + - 'Technique 6.5: KCS Process Integration Indicators' + - ❓ --- +Status: Unknown ❓ + ##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) @@ -18,7 +22,7 @@ The system shall provide/enables reports showing the PAR (link accuracy and capt Technique 6.5: KCS Process Integration Indicators ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/07.md b/docs/performance assessment/07.md index cd22af7016b984202a1606b0c0150186c6a122bc..c365da31f925fbdc1b82015f7f3313e4532c0a1f 100644 --- a/docs/performance assessment/07.md +++ b/docs/performance assessment/07.md @@ -3,8 +3,12 @@ tags: - Reuse - Linking - Scenario 09 + - 'Technique 3.3: Linking' + - ❓ --- +Status: Unknown ❓ + ##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.) @@ -21,7 +25,7 @@ The system shall provide reports showing how often KCS articles (mandatory) and Technique 3.3: Linking ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/08.md b/docs/performance assessment/08.md index e25c3bc9a4fa40bd1adc548f38f6232a24afb0e8..2c35012ab34970fd8c42b74135943a77e96c0d95 100644 --- a/docs/performance assessment/08.md +++ b/docs/performance assessment/08.md @@ -3,8 +3,11 @@ tags: - Closing Thoughts on the Solve Loop - Collective Ownership in the Solve Loop - Scenario 09 + - ❓ --- +Status: Unknown ❓ + ##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). @@ -18,7 +21,7 @@ The system shall provide reports showing history of the KCS article and the indi Closing Thoughts on the Solve Loop ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/09.md b/docs/performance assessment/09.md index db051dde4dd625a76e19bde71c87fe160714c541..680f35d338d7119be4d7b8e9c9d85b9843d89d15 100644 --- a/docs/performance assessment/09.md +++ b/docs/performance assessment/09.md @@ -5,8 +5,12 @@ tags: - Referencing or Linking to Other Information Sources - Not Mandatory - Scenario 09 + - 'Technique 3.3: Linking' + - ❎ --- +Status: Not Mandatory ❎ + ##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. @@ -21,7 +25,7 @@ The system shall provide reports showing how often a KCS article was used as a r Technique 3.3: Linking ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/10.md b/docs/performance assessment/10.md index 1102a2b5a49767d6edfa616bf0b83cefd04224d1..bf12c86663ed1d245d91d3d9032a3dc6252f0b2b 100644 --- a/docs/performance assessment/10.md +++ b/docs/performance assessment/10.md @@ -4,8 +4,13 @@ tags: - Knowledge Domain Analysis - Creating Evolve Loop Articles - Methods for Prioritizing Root Cause Analysis + - 'Technique 5.4: Creating Evolve Loop Articles' + - 'Technique 5.9: Knowledge Domain Analysis' + - ❓ --- +Status: Unknown ❓ + ##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 diff --git a/docs/performance assessment/11.md b/docs/performance assessment/11.md index e4b30d904e5ee8ad5c3c40f14a9cf3d8216f6dd3..53329f9648ea88a5c63db1d181e2f9b110bf6fcb 100644 --- a/docs/performance assessment/11.md +++ b/docs/performance assessment/11.md @@ -4,20 +4,28 @@ tags: - Assessing the Creation of Value - Radar Charts - Creating a Value Footprint - Scenario 09 + - 'Technique 7.3: Assessing the Creation of Value' + - ❓ --- +Status: Unknown ❓ + ##Mandatory## The system shall provide reports showing a Radar chart for an individual over a particular period of time that contains these mandatory elements: -Content Standard Checklist -Citations or Link Rate -Contribution Index (old participation) -Link Accuracy + +* Content Standard Checklist +* Citations or Link Rate +* Contribution Index (old participation) +* Link Accuracy + and optionally show: -# of incidents -Articles creation -Articles modification -Articles published + +* Number of incidents +* Articles creation +* Articles modification +* Articles published + These shall be normalized to a team average that is configurable. ##Practice/Technique## @@ -30,7 +38,7 @@ These shall be normalized to a team average that is configurable. Technique 7.3: Assessing the Creation of Value ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/12.md b/docs/performance assessment/12.md index 59f9fa83c486a8356165733f773432f907309b00..540c0d413f04ad6aa50c97a89aba3a9f03c24626 100644 --- a/docs/performance assessment/12.md +++ b/docs/performance assessment/12.md @@ -3,19 +3,27 @@ tags: - Content Health - Self-Service Measures - Scenario 09 + - 'Technique 5.12: Self-Service Measures' + - ❓ --- +Status: Unknown ❓ + ##Mandatory## The system shall provide reports showing the following self-service metrics over a particular period of time. -Search strings -Articles viewed -Feedback on articles -Deflection/avoidance + +* Search strings +* Articles viewed +* Feedback on articles +* Deflection/avoidance + and optionally show: -Abandoned search strings -Empty search -Search escalation + +* Abandoned search strings +* Empty search +* Search escalation + These reports will be capable of segmentation by knowledge domain (category, tag, or role.), date/time, owner, creator ##Practice/Technique## @@ -27,7 +35,7 @@ These reports will be capable of segmentation by knowledge domain (category, tag Technique 5.12: Self-Service Measures ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/13.md b/docs/performance assessment/13.md index eb5894a5660ddc605fa174e28f3a3e17ae4b7d88..3f15b766babe85fe8bd25654e11eea4a07529df9 100644 --- a/docs/performance assessment/13.md +++ b/docs/performance assessment/13.md @@ -4,11 +4,16 @@ tags: - Self-Service Measures - Integrating Feedback - Scenario 09 + - 'Technique 5.12: Self-Service Measures' + - ❓ --- +Status: Unknown ❓ + ##Mandatory## The system shall provide reports showing the following article feedback. + 1. Feedback comments associated with article 2. State of feedback 3. Date feedback was created @@ -25,7 +30,7 @@ The system shall provide reports showing the following article feedback. Technique 5.12: Self-Service Measures ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/14.md b/docs/performance assessment/14.md index d441beb7e2944717032269f2599460561fac5c2d..839cb4766512358fa7e425c5f521782b1117805e 100644 --- a/docs/performance assessment/14.md +++ b/docs/performance assessment/14.md @@ -5,8 +5,12 @@ tags: - Performance Assessment - KCS Roles and the Licensing Model - Scenario 07 + - 'Technique 5.12: Self-Service Measures' + - ❓ --- +Status: Unknown ❓ + ##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. @@ -22,7 +26,7 @@ The system shall provide visibility management options that uses the user role, Technique 5.12: Self-Service Measures ##Demo Requirements for Verified Only## -Scenario 7 +[Scenario 07](../scenario/07.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/15.md b/docs/performance assessment/15.md index 44d08913cc15d43960ca02286b2ac8a35f5eb907..c9216345243a2eef5f4c3a6cacba591ad9c7f50f 100644 --- a/docs/performance assessment/15.md +++ b/docs/performance assessment/15.md @@ -3,8 +3,12 @@ tags: - Performance Assessment - KCS Roles and the Licensing Model - Scenario 07 + - 'Technique 7.1: KCS Roles and the Licensing Model' + - ❓ --- +Status: Unknown ❓ + ##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. @@ -18,7 +22,7 @@ KCS articles in each level of audience shall be searchable and visible to an app Technique 7.1: KCS Roles and the Licensing Model ##Demo Requirements for Verified Only## -Scenario 7 +[Scenario 07](../scenario/07.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/16.md b/docs/performance assessment/16.md index 1134d68c663879fa3be921928a603a8a60e0fb70..8ba773c2f8d820ae8429823908b27023b3857ba1 100644 --- a/docs/performance assessment/16.md +++ b/docs/performance assessment/16.md @@ -3,8 +3,12 @@ tags: - Performance Assessment - KCS Roles and the Licensing Model - Scenario 07 + - 'Technique 7.1: KCS Roles and the Licensing Model' + - ❓ --- +Status: Unknown ❓ + ##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. @@ -18,7 +22,7 @@ KCS articles in each level of governance shall be editable to an appropriate KCS Technique 7.1: KCS Roles and the Licensing Model ##Demo Requirements for Verified Only## -Scenario 7 +[Scenario 07](../scenario/07.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/17.md b/docs/performance assessment/17.md index 7a069d9b0f6b217559606f2a11fa099813b735d6..234dfd0c4ac33e4c2e492a0513cc7ab23e716ff1 100644 --- a/docs/performance assessment/17.md +++ b/docs/performance assessment/17.md @@ -2,8 +2,12 @@ tags: - Performance Assessment - Coaching + - 'Technique 7.2: Coaching for Success' + - ❓ --- +Status: Unknown ❓ + ##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. diff --git a/docs/performance assessment/18.md b/docs/performance assessment/18.md index 18fa2ade719581f5671ba39e779da40a33a5b14d..f20a9b24bad8277fe3894ff104284a2711c7ec3f 100644 --- a/docs/performance assessment/18.md +++ b/docs/performance assessment/18.md @@ -1,4 +1,9 @@ +--- +tags: + - ❓ +--- +Status: Unknown ❓ ##Mandatory## diff --git a/docs/performance assessment/19.md b/docs/performance assessment/19.md index 4072fea1de8bfc97af6172fe371889cd143097e7..c1b0bd715fe3953925202abe169b46f89f72d9f7 100644 --- a/docs/performance assessment/19.md +++ b/docs/performance assessment/19.md @@ -1,8 +1,11 @@ --- tags: - Not Mandatory + - ❓ --- +Status: Unknown ❓ + ##Not Mandatory## Mechanism for storing article activity data. Describe in documentation column. diff --git a/docs/performance assessment/20.md b/docs/performance assessment/20.md index fd873dee1cd012531a447e9fdc660002c2994f7b..711a282c3ab29adf305670e9c25d0994702d7c32 100644 --- a/docs/performance assessment/20.md +++ b/docs/performance assessment/20.md @@ -1,4 +1,9 @@ +--- +tags: + - ❓ +--- +Status: Unknown ❓ ##Mandatory## diff --git a/docs/performance assessment/21.md b/docs/performance assessment/21.md index d84ac2e85adde560db7ab846d776caccc39ef024..04b9021fd174b0f28be21bb0fee72fa7f3bfeb27 100644 --- a/docs/performance assessment/21.md +++ b/docs/performance assessment/21.md @@ -1,4 +1,9 @@ +--- +tags: + - ❓ +--- +Status: Unknown ❓ ##Mandatory## diff --git a/docs/performance assessment/22.md b/docs/performance assessment/22.md index c8ded3fca04d530a5901b2919e0ad703b45188d4..c9da06956a6cb88968fa5cb039b0ecc1b33b9c3b 100644 --- a/docs/performance assessment/22.md +++ b/docs/performance assessment/22.md @@ -1,4 +1,9 @@ +--- +tags: + - ❓ +--- +Status: Unknown ❓ ##Mandatory## diff --git a/docs/performance assessment/23.md b/docs/performance assessment/23.md index 850550217d2dc7bad53c03e541ff83d9983c3deb..342dbf5e203eb959b1763179a06ffe90c36771b7 100644 --- a/docs/performance assessment/23.md +++ b/docs/performance assessment/23.md @@ -1,4 +1,9 @@ +--- +tags: + - ❓ +--- +Status: Unknown ❓ ##Mandatory## diff --git a/docs/performance assessment/24.md b/docs/performance assessment/24.md index d2a6cbcb5c4386d2f762e8ec7bd7f735a7ea9f8f..2bddc9fda41b2b065e32979de899b7eca5bb898e 100644 --- a/docs/performance assessment/24.md +++ b/docs/performance assessment/24.md @@ -3,9 +3,13 @@ tags: - Content Health - Creating Evolve Loop Articles - Plugging Content Gaps Identified from the Web - - Scenario 11 + - Scenario 01 + - 'Technique 5.4: Creating Evolve Loop Articles' + - ❓ --- +Status: Unknown ❓ + ##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 @@ -23,7 +27,7 @@ selected search results, and where in the results list (Search Engine Result Pag Technique 5.4: Creating Evolve Loop Articles ##Demo Requirements for Verified Only## -Scenario 11 +[Scenario 01](../scenario/01.md)1 ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/25.md b/docs/performance assessment/25.md index e13865b6450d33094539a3a9d663c3d443c42bd8..5af029cbfd07019624f8f765d87aacb5c10d91e3 100644 --- a/docs/performance assessment/25.md +++ b/docs/performance assessment/25.md @@ -3,9 +3,13 @@ tags: - Content Health - Creating Evolve Loop Articles - Plugging Content Gaps Identified from the Web - - Scenario 11 + - Scenario 01 + - 'Technique 5.4: Creating Evolve Loop Articles' + - ❓ --- +Status: Unknown ❓ + ##Mandatory## Report on passive failed search. Abandoned, ability to filter and trigger and the ability to report on. @@ -20,7 +24,7 @@ Report on passive failed search. Abandoned, ability to filter and trigger and th Technique 5.4: Creating Evolve Loop Articles ##Demo Requirements for Verified Only## -Scenario 11 +[Scenario 01](../scenario/01.md)1 ##OB/Config/Cust/NS/SF## diff --git a/docs/performance assessment/26.md b/docs/performance assessment/26.md index 9e2a119091c813fc87ca2d778b75e68d8c3b8896..e265081e15179f31ef091a17ad9b601710625511 100644 --- a/docs/performance assessment/26.md +++ b/docs/performance assessment/26.md @@ -3,8 +3,12 @@ tags: - Content Health - Knowledge Domain Analysis - Not Mandatory + - 'Technique 5.9: Knowledge Domain Analysis' + - ❎ --- +Status: 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 diff --git a/docs/process integration/01.md b/docs/process integration/01.md index 9232d6ae297db7fb3a6ecefc315f7ec0c8d42c8f..e314615c483ab0e6ae61f3867e6a5befbe9f03fc 100644 --- a/docs/process integration/01.md +++ b/docs/process integration/01.md @@ -4,8 +4,12 @@ tags: - Seamless Technology Integration - Integration of Workflow and Technology with CRM, IM, and Other Tools - Scenario 01 + - 'Technique 6.2: Seamless Technology Integration' + - ❓ --- +Status: Unknown ❓ + ##Mandatory## User interface and integrated workflow @@ -20,7 +24,7 @@ User interface and integrated workflow Technique 6.2: Seamless Technology Integration ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/process integration/02.md b/docs/process integration/02.md index df542c19006c970b589fc9755aaea8806b73fb18..23a55dee9f0a6b9a7a2c0f36574176b8da761e3d 100644 --- a/docs/process integration/02.md +++ b/docs/process integration/02.md @@ -2,15 +2,20 @@ tags: - Process Integration - Search Technology for KCS + - 'Technique 6.3: Search Technology for KCS' + - ❓ --- +Status: Unknown ❓ + ##Mandatory## Meta Data Management – Ability to use metadata to change the ranking, filtering, and relevance of search results. Metadata can include: -(1) A predefined list of attributes (e.g., ontologies or taxonomies) -(2) a flexible undefined field (e.g., textual title or description) -(3) Crowd sourced lists (e.g., tags) -(4) System-generated metadata (e.g., reuse counts) + +1. A predefined list of attributes (e.g., ontologies or taxonomies) +2. a flexible undefined field (e.g., textual title or description) +3. Crowd sourced lists (e.g., tags) +4. System-generated metadata (e.g., reuse counts) ##Practice/Technique## diff --git a/docs/process integration/03.md b/docs/process integration/03.md index 1da2d62c438eb77748d080e67fca32258fb778e3..99dc4ef78f072ec844dd64f08dea554eae5c8ee1 100644 --- a/docs/process integration/03.md +++ b/docs/process integration/03.md @@ -3,8 +3,12 @@ tags: - Process Integration - Search Technology for KCS - Not Mandatory + - 'Technique 6.3: Search Technology for KCS' + - ❓ --- +Status: Unknown ❓ + ##Not Mandatory## Describe the capabilities for personalization to audiences, known individuals, or contexts diff --git a/docs/process integration/04.md b/docs/process integration/04.md index 47fd34b4a36e0914d2685c3fdeb0d1ab57121554..61669ca1f48a36b7966eb4e30d039baa4c07dcf5 100644 --- a/docs/process integration/04.md +++ b/docs/process integration/04.md @@ -3,8 +3,12 @@ tags: - Process Integration - Search Technology for KCS - Not Mandatory + - 'Technique 6.3: Search Technology for KCS' + - ❎ --- +Status: 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 diff --git a/docs/process integration/05.md b/docs/process integration/05.md index db1f1943381ce247b791aa70c0caf4feff35aa79..eabbf1eb377f72234df8f319d36424648442b5d0 100644 --- a/docs/process integration/05.md +++ b/docs/process integration/05.md @@ -2,8 +2,12 @@ tags: - Process Integration - Search Technology for KCS + - 'Technique 6.3: Search Technology for KCS' + - ❓ --- +Status: Unknown ❓ + ##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 diff --git a/docs/process integration/06.md b/docs/process integration/06.md index f6990034ab8e510d0952ca7261dad352723243e2..79f0ad8320954fcae84c1a833ba08e208562d648 100644 --- a/docs/process integration/06.md +++ b/docs/process integration/06.md @@ -4,8 +4,12 @@ tags: - Search Technology of KCS - Planning for the Ongoing Effort of Search Tuning - Scenario 07 + - 'Technique 6.3: Search Technology for KCS' + - ❓ --- +Status: Unknown ❓ + ##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. @@ -21,7 +25,7 @@ For example, by maintaining dictionaries / acronym / synonym lists, taxonomies a Technique 6.3: Search Technology for KCS ##Demo Requirements for Verified Only## -Scenario 7 +[Scenario 07](../scenario/07.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/process integration/07.md b/docs/process integration/07.md index 7216fafb8331501df6dbb7a55b0170f28d03200c..4530004f102e847369609bd2bd78f5d21b21a992 100644 --- a/docs/process integration/07.md +++ b/docs/process integration/07.md @@ -3,8 +3,12 @@ tags: - Process Integration - Search Technology of KCS - Planning for the Ongoing Effort of Search Tuning + - 'Technique 6.3: Search Technology for KCS' + - ❓ --- +Status: Unknown ❓ + ##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.) diff --git a/docs/process integration/08.md b/docs/process integration/08.md index 6f1e31f4b6f3194709f2b33d99be350566c79f2b..07947284c1805bbcc5aa4a414b2a0d15226b3b76 100644 --- a/docs/process integration/08.md +++ b/docs/process integration/08.md @@ -1,11 +1,15 @@ --- tags: - Not Mandatory + - ❓ --- +Status: Unknown ❓ + ##Not Mandatory## Describe your process for publishing content to the web and SEO. + 1. xml site map 2. htaccess for redirects 3. canonical urls (nicely formatted) diff --git a/docs/process integration/09.md b/docs/process integration/09.md index 93855bf8641054dff780fc01799e4d56bbbb5099..2fc04c3c57ba38cb77238a0c1a1a80bbc3075e09 100644 --- a/docs/process integration/09.md +++ b/docs/process integration/09.md @@ -3,8 +3,12 @@ tags: - Structure - Utilize Simple Templates - Not Mandatory + - 'Technique 5.1: KCS Article Structure' + - ❓ --- +Status: Unknown ❓ + ##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 diff --git a/docs/process integration/10.md b/docs/process integration/10.md index 795c87e17a74b51b20a03a3282b2b0d1c987737a..bcef73beb9315ed91481b44178c387348bdfe527 100644 --- a/docs/process integration/10.md +++ b/docs/process integration/10.md @@ -4,8 +4,12 @@ tags: - Self-Service Success - Not Mandatory - Scenario 01 + - 'Technique 5.11: Self-Service Success' + - ❓ --- +Status: Unknown ❓ + ##Not Mandatory## The system shall extend this navigation or browsing experience to external (non knowledge base) content indexed by the system @@ -20,7 +24,7 @@ The system shall extend this navigation or browsing experience to external (non Technique 5.11: Self-Service Success ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/process integration/11.md b/docs/process integration/11.md index 2640dd6354bb8397b0985b8b1d9b3bae32d6a6c8..f9e811b05228ad39fb64433adb4e61d2653b8d52 100644 --- a/docs/process integration/11.md +++ b/docs/process integration/11.md @@ -2,8 +2,12 @@ tags: - Process Integration - Seamless Technology Integration + - 'Technique 6.2: Seamless Technology Integration' + - ❓ --- +Status: Unknown ❓ + ##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. diff --git a/docs/references.md b/docs/references.md new file mode 100644 index 0000000000000000000000000000000000000000..dfe2a024197ee56c8309f6886cb6677394a397fe --- /dev/null +++ b/docs/references.md @@ -0,0 +1,6 @@ + + +[KCS v6 Verified & Aligned Self-Assessment Worksheets](https://docs.google.com/spreadsheets/d/1Mv7jfLnvylAoIplX2lHLfp8GZhpugdxn690lGz9XMis/edit?gid=1560706477#gid=1560706477) + + +[Technology Demo Scripts (Scenarios)](http://www.serviceinnovation.org/included/docs/cert/verified_v6_tech_demo.pdf) diff --git a/docs/reuse/01.md b/docs/reuse/01.md index f2f000870abde1667b05966db378f67c687c175f..b65158d67364e86847b6cec73d96fd9d8818a721 100644 --- a/docs/reuse/01.md +++ b/docs/reuse/01.md @@ -4,12 +4,16 @@ tags: - Linking - Linking an Incident to Non-KCS Content - Not Mandatory + - ❎ --- +Status: 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) 3. Federated search (non-mandatory) diff --git a/docs/reuse/02.md b/docs/reuse/02.md index d34a8a6cc3b4dde4afb297b0f6e914cad6ff50ec..496b1d28b47c20ba115f3d7540767b57c0a5a5fa 100644 --- a/docs/reuse/02.md +++ b/docs/reuse/02.md @@ -1,8 +1,11 @@ --- tags: - Scenario 01 + - ❓ --- +Status: Unknown ❓ + ##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. @@ -14,7 +17,7 @@ The system shall support the provisioning of internal (inside the firewall) and ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/reuse/03.md b/docs/reuse/03.md index 57a286f733eaf16af1631a47fc26f69862759f65..3a484d61a6bbb99d2b135fe94139d3e69beb0a6f 100644 --- a/docs/reuse/03.md +++ b/docs/reuse/03.md @@ -4,8 +4,12 @@ tags: - Linking - Referencing and Linking to Other Information Sources - Not Mandatory + - 'Technique 3.3: Linking' + - ✅ --- +Status: Complete ✅ + ##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.) @@ -24,6 +28,12 @@ The system shall provide a mechanism to distinguish a reference link from a reso ##OB/Config/Cust/NS/SF## +###Out of the Box### +Reference links, urls in a text field, are handled with the community Backlinks +module. + +Linking an article as a solution is accomplished with the community Knowledge +module. Linking incidents to articles is done in a separate form. ##Native Product Capability## diff --git a/docs/reuse/04.md b/docs/reuse/04.md index 4953e15b485e7f2db0e0ce8338feb939c8b93c39..b55bbec662658a14786304e879598b4d6d16e0ac 100644 --- a/docs/reuse/04.md +++ b/docs/reuse/04.md @@ -4,8 +4,12 @@ tags: - Linking - Many-to-Many Relationship Between Incidents and Articles - Scenario 03 + - 'Technique 3.3: Linking' + - ✅ --- +Status: Complete ✅ + ##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.) @@ -21,9 +25,11 @@ The linking mechanism shall be structured such that each article may be linked t [Technique 3.3: Linking](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/030/030) ##Demo Requirements for Verified Only## -Scenario 3 +[Scenario 03](../scenario/03.md) ##OB/Config/Cust/NS/SF## +###Out of the Box### +The knowledge module provides a separate entity to link articles to incidents. ##Native Product Capability## diff --git a/docs/reuse/05.md b/docs/reuse/05.md index e3ad51911f89fe71dc04d8a11685162f156493e7..d2541796bde4331fb4782a52da377bae5c2351e6 100644 --- a/docs/reuse/05.md +++ b/docs/reuse/05.md @@ -4,8 +4,12 @@ tags: - Linking - Linking to an existing KCS Article - Scenario 03 + - 'Technique 3.3: Linking' + - ✅ --- +Status: Complete ✅ + ##Mandatory## Links shall be capable of being deleted by the analyst. @@ -21,10 +25,13 @@ Links shall be capable of being deleted by the analyst. [Technique 3.3: Linking](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/030/030) ##Demo Requirements for Verified Only## -Scenario 3 +[Scenario 03](/scenario/03.md) ##OB/Config/Cust/NS/SF## +###Out of the Box### +Knowledge workers can unlink their own links, a soft delete. +An administrator can unlink any, and can also delete links. ##Native Product Capability## diff --git a/docs/reuse/06.md b/docs/reuse/06.md index bc1b12e3aab3ce83ada7be52c52231ce1c6b8dd2..105945acd5e351f20c81c388b66a53a3520b22e1 100644 --- a/docs/reuse/06.md +++ b/docs/reuse/06.md @@ -5,8 +5,12 @@ tags: - Referencing and Linking to Other Information Sources - Not Mandatory - Scenario 09 + - 'Technique 3.3: Linking' + - ❎ --- +Status: Not Mandatory ❎ + ##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. @@ -22,7 +26,7 @@ Linking incident to other types of content that solve the issue. These links sha [Technique 3.3: Linking](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/030/030) ##Demo Requirements for Verified Only## -Scenario 9 +[Scenario 09](../scenario/09.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/reuse/07.md b/docs/reuse/07.md index 8cb5b9fd606480ee9b34f6d7ef421558bd24e612..210a67b44b5a6b355a3fe81c5a9e3fecc7a30dad 100644 --- a/docs/reuse/07.md +++ b/docs/reuse/07.md @@ -3,9 +3,13 @@ tags: - Reuse - Linking - Managing Article Versions - - Scenario 10 + - Scenario 01 + - 'Technique 3.3: Linking' + - ❌ --- +Status: Incomplete ❌ + ##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. @@ -21,7 +25,7 @@ The linking mechanism shall allow the analyst viewing the incident to see both t [Technique 3.3: Linking](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/030/030) ##Demo Requirements for Verified Only## -Scenario 10 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## diff --git a/docs/scenario/index.md b/docs/scenario/index.md new file mode 100644 index 0000000000000000000000000000000000000000..1d68d95acfc490da4145a1920442cfac8e45adb0 --- /dev/null +++ b/docs/scenario/index.md @@ -0,0 +1,22 @@ + +[Scenario 1: External Self-Service to Incident - New Article](01.md) + +[Scenario 2: External Self-Service - Reuse Article. Add and Process Feedback](02.md) + +[Scenario 3: Internal Reuse with Incident](03.md) + +[Scenario 4: Internal Fix-it with Incident](04.md) + +[Scenario 5: KCS Candidate Creates Article with Incident, Check for Duplicates](05.md) + +[Scenario 6: Report and Merge Duplicates](06.md) + +[Scenario 7: Administration](07.md) + +[Scenario 8: Reports](08.md) + +[Scenario 9: Unique ID System of Record to Assisted - New Article](09.md) + +[Scenario 10: External Self-Service No ID System of Record Explicit Reuse Article](10.md) + +[Scenario 11: External Self-Service, No ID System of Record Search Behaviors, Log of Search Strings and Click Streams on Articles](11.md) \ No newline at end of file diff --git a/docs/structure/01.md b/docs/structure/01/index.md similarity index 50% rename from docs/structure/01.md rename to docs/structure/01/index.md index 1fd3be115f7abd68b790562964c2ef496d99545e..454dbac6b306bf90fad4a83d431e62df7d2f19f1 100644 --- a/docs/structure/01.md +++ b/docs/structure/01/index.md @@ -3,8 +3,14 @@ tags: - Structure - Utilize Simple Templates - Scenario 01 + - 'Technique 2.1: Use a Simple Template' + - ✅ + - drupal/core/field + - drupal/core/field_ui --- +Status: Complete ✅ + ##Mandatory## A KCS article template that includes the following fields: @@ -25,17 +31,30 @@ A KCS article template that includes the following fields: [Technique 2.1: Use a Simple Template](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/020/010) ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](/scenario/01.md) ##OB/Config/Cust/NS/SF## +###Out of the Box### + +**admin/structure/types/manage/article/fields** + +The fields are provided by the Core module 'field'. Notes are provided by the Community module, 'Moderation note'. + + ##Native Product Capability## +[Field](/tags/#drupalcorefield) + ##Mechanism for Config## +A graphic interface is provided by the Core module [Field UI](/tags/#drupalcorefield_ui). + ##Config Strategy## +The path and screen shot above shows the administration page for the Article's fields. There are options to Delete, Edit, Create, and Add an Existing field. + ##Dependencies & Version Numbers## diff --git a/docs/structure/01/structure 01 fields.png b/docs/structure/01/structure 01 fields.png new file mode 100644 index 0000000000000000000000000000000000000000..9514df07a6bda30d9a84e0172bd5daae2d6f017b Binary files /dev/null and b/docs/structure/01/structure 01 fields.png differ diff --git a/docs/structure/02.md b/docs/structure/02/index.md similarity index 73% rename from docs/structure/02.md rename to docs/structure/02/index.md index 84ffd67e5dc953b010d315e05cf71ccf7c48950d..942bde706ed3f29c5e8dc7896ee06dcffc0199ac 100644 --- a/docs/structure/02.md +++ b/docs/structure/02/index.md @@ -3,8 +3,12 @@ tags: - Structure - Utilize Simple Templates - Scenario 01 + - 'Technique 2.1: Use a Simple Template' + - ✅ --- +Status: Complete ✅ + ##Mandatory## Issue can be captured in the workflow in a template that helps to structure the content. @@ -19,10 +23,13 @@ Issue can be captured in the workflow in a template that helps to structure the [Technique 2.1: Use a Simple Template](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/020/010) ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## +###Out of the Box### +**admin/structure/types/manage/article/fields** +The Issue field is provided out of the box. ##Native Product Capability## diff --git a/docs/structure/03.md b/docs/structure/03/index.md similarity index 67% rename from docs/structure/03.md rename to docs/structure/03/index.md index e070efcf74f09e639613686e96e08edf6df7a816..c215e396e46febe5f784bfb7296174eb7a978305 100644 --- a/docs/structure/03.md +++ b/docs/structure/03/index.md @@ -4,8 +4,13 @@ tags: - Utilize Simple Templates - Not Mandatory - Scenario 01 + - 'Technique 2.1: Use a Simple Template' + - ✅ + - drupal/core/node --- +Status: Complete ✅ + ##Not Mandatory## Template structure of the Article is not alterable by the user when creating or editing an article @@ -21,12 +26,19 @@ Template structure of the Article is not alterable by the user when creating or [Technique 2.1: Use a Simple Template](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/020/010) ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](/scenario/01.md) ##OB/Config/Cust/NS/SF## +###Out of the Box### +**node/add/article** + +The template structure is implemented with different fields. + + ##Native Product Capability## +[Node](/tags/#drupalcorenode) ##Mechanism for Config## diff --git a/docs/structure/03/structure 03 node form.png b/docs/structure/03/structure 03 node form.png new file mode 100644 index 0000000000000000000000000000000000000000..5564285ecf12836443aec916dfb012fb6ee85146 Binary files /dev/null and b/docs/structure/03/structure 03 node form.png differ diff --git a/docs/structure/04.md b/docs/structure/04.md deleted file mode 100644 index 7fbfc7d3d537b3670208541756010c88892fcf9d..0000000000000000000000000000000000000000 --- a/docs/structure/04.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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. - -##Practice/Technique## - -* Structure -* Utilize Simple Templates - -##Reference: KCS v6 Practices Guide## - -[Technique 2.1: Use a Simple Template](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/020/010) - -##Demo Requirements for Verified Only## -Scenario 7 - -##OB/Config/Cust/NS/SF## - - -##Native Product Capability## - -##Mechanism for Config## - -##Config Strategy## - -##Dependencies & Version Numbers## - - -##Documentation## diff --git a/docs/structure/04/index.md b/docs/structure/04/index.md new file mode 100644 index 0000000000000000000000000000000000000000..1009044da530da7a14637c40065fa56993e1dd71 --- /dev/null +++ b/docs/structure/04/index.md @@ -0,0 +1,53 @@ +--- +tags: + - Structure + - Utilize Simple Templates + - Scenario 07 + - 'Technique 2.1: Use a Simple Template' + - ✅ + - drupal/core/node +--- + +Status: Complete ✅ + +##Mandatory## + +Administrators may specify or adjust which fields are being present in any given +template and multiple templates may be maintained. + +##Practice/Technique## + +* Structure +* Utilize Simple Templates + +##Reference: KCS v6 Practices Guide## + +[Technique 2.1: Use a Simple Template](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/020/010) + +##Demo Requirements for Verified Only## +[Scenario 07](/scenario/07.md) + +##OB/Config/Cust/NS/SF## + +###Out of the Box### +**admin/structure/types/manage/article/form-display** + + + +##Native Product Capability## +[Node](/tags/#drupalcorenode) + +##Mechanism for Config## +A graphic interface is provided. + +##Config Strategy## + +The path and screen shot above shows the administration page for managing the +article's form. Fields can be rearranged, or hidden. Some fields have options to +render as different form elements. + + +##Dependencies & Version Numbers## + + +##Documentation## diff --git a/docs/structure/04/structure 04 node form display.png b/docs/structure/04/structure 04 node form display.png new file mode 100644 index 0000000000000000000000000000000000000000..08c5925d5a1ea24e85b55209202d8b1c0ecbca7c Binary files /dev/null and b/docs/structure/04/structure 04 node form display.png differ diff --git a/docs/structure/05.md b/docs/structure/05/index.md similarity index 71% rename from docs/structure/05.md rename to docs/structure/05/index.md index 38b9e0e70def85571a762778bc7e4256a70f1cc6..622cddd3944cf2a86007056ee24d9be037ce1a49 100644 --- a/docs/structure/05.md +++ b/docs/structure/05/index.md @@ -3,8 +3,12 @@ tags: - Structure - Utilize Simple Templates - Scenario 07 + - 'Technique 2.1: Use a Simple Template' + - ✅ --- +Status: Complete ✅ + ##Mandatory## At KCS Article capture, user may select which template they use, although a default may be maintained. @@ -19,14 +23,19 @@ At KCS Article capture, user may select which template they use, although a defa [Technique 2.1: Use a Simple Template](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/020/010) ##Demo Requirements for Verified Only## -Scenario 7 +[Scenario 07](/scenario/07.md) ##OB/Config/Cust/NS/SF## +###Out of the Box### + +**node/add** + ##Native Product Capability## ##Mechanism for Config## +A graphic interface is provided for creating new article types. ##Config Strategy## diff --git a/docs/structure/05/structure 05 add node.png b/docs/structure/05/structure 05 add node.png new file mode 100644 index 0000000000000000000000000000000000000000..1c50a2bfb61ba9d34555ccbb886d2796b4ea30f0 Binary files /dev/null and b/docs/structure/05/structure 05 add node.png differ diff --git a/docs/structure/06.md b/docs/structure/06.md deleted file mode 100644 index d2be6056b869aafa8f67fc5c62b84ce0afdccc96..0000000000000000000000000000000000000000 --- a/docs/structure/06.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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 - -##Practice/Technique## - -* Structure -* Details on the Resolution Field - -##Reference: KCS v6 Practices Guide## - -Technique 5.1: KCS Article Structure - -##Demo Requirements for Verified Only## - - -##OB/Config/Cust/NS/SF## - - -##Native Product Capability## - -##Mechanism for Config## - -##Config Strategy## - -##Dependencies & Version Numbers## - - -##Documentation## diff --git a/docs/structure/06/index.md b/docs/structure/06/index.md new file mode 100644 index 0000000000000000000000000000000000000000..64ae751c45551d4aee904deb6b1c0f9ccc6b5ade --- /dev/null +++ b/docs/structure/06/index.md @@ -0,0 +1,58 @@ +--- +tags: + - Structure + - Details on the Resolution Field + - Not Mandatory + - 'Technique 5.1: KCS Article Structure' + - ✅ + - drupal/contrib/field_permissions +--- + +Status: Complete ✅ + +##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 + +##Practice/Technique## + +* Structure +* Details on the Resolution Field + +##Reference: KCS v6 Practices Guide## + +Technique 5.1: KCS Article Structure + +##Demo Requirements for Verified Only## + + +##OB/Config/Cust/NS/SF## +###Config### + +1. Goto **admin/modules** +2. Enable the Field Permissions module. + + +##Native Product Capability## +Drupal provides a hook to granular control access at the field level, +[hook_entity_field_access](https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Entity%21entity.api.php/function/hook_entity_field_access). +The Field Permissions module uses this API hook. + +##Mechanism for Config## +There is a form to configure field level access. + +##Config Strategy## +Once Field Permissions module is installed, you need to edit the field settings form to enable permissions for each field where you need this feature. You can enable any of the following permission types: + +* Create own value for the field +* Edit own value for the field +* Edit anyone's value for the field +* View own value for the field +* View anyone's value for the field + +The settings for the Resolution field is located here: **admin/structure/types/manage/article/fields/node.article.field_resolution** + +##Dependencies & Version Numbers## +[Field Permissions](https://www.drupal.org/project/field_permissions) + +##Documentation## diff --git a/docs/structure/07.md b/docs/structure/07/index.md similarity index 72% rename from docs/structure/07.md rename to docs/structure/07/index.md index cc4e50b45587727757ded7877db7eeda8c806d80..f39905096c67177266aaf83058124e8a887ca78c 100644 --- a/docs/structure/07.md +++ b/docs/structure/07/index.md @@ -3,8 +3,12 @@ tags: - Structure - Complete Thoughts, Not Complete Sentences - Scenario 01 + - 'Technique 2.2: Complete Thoughts, Not Complete Sentences' + - ✅ --- +Status: Complete ✅ + ##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. @@ -19,10 +23,12 @@ Captured KCS Article content from initial entry will support at least basic form [Technique 2.2: Complete Thoughts, Not Complete Sentences](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/020/020) ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## - +###Out of the Box### +The Core modules 'editor' and 'ckeditor5' provide this ability. Editor allows +different WYSIWYG editors to be used. CKEditor is the default editor. ##Native Product Capability## diff --git a/docs/structure/08.md b/docs/structure/08/index.md similarity index 68% rename from docs/structure/08.md rename to docs/structure/08/index.md index bf3bc3ac5ea6c46a54a11ace66a1e88c3c1db9f6..784b92f52ee82277ad9b65c8c8228a1ac4a4a8a5 100644 --- a/docs/structure/08.md +++ b/docs/structure/08/index.md @@ -3,8 +3,12 @@ tags: - Structure - Complete Thoughts, Not Complete Sentences - Scenario 01 + - 'Technique 2.2: Complete Thoughts, Not Complete Sentences' + - ✅ --- +Status: Complete ✅ + ##Mandatory## KCS Articles can be entered and edited as bullet lists and numbered lists. @@ -19,10 +23,12 @@ KCS Articles can be entered and edited as bullet lists and numbered lists. [Technique 2.2: Complete Thoughts, Not Complete Sentences](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/020/020) ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## - +###Out of the Box### +The Core modules 'editor' and 'ckeditor5' provide this ability. Editor allows +different WYSIWYG editors to be used. CKEditor is the default editor. ##Native Product Capability## diff --git a/docs/structure/09.md b/docs/structure/09/index.md similarity index 73% rename from docs/structure/09.md rename to docs/structure/09/index.md index ccdffd641b8ff1822452baa2bddcbf6e6010ec78..144b77556227a62f0dc13a25e2fdf67d1a210523 100644 --- a/docs/structure/09.md +++ b/docs/structure/09/index.md @@ -4,8 +4,12 @@ tags: - Linking - Referencing and Linking to Other Information Sources - Scenario 01 + - 'Technique 3.3: Linking' + - ✅ --- +Status: Complete ✅ + ##Mandatory## KCS articles can have embedded hyperlinks to other sources of content, such as KCS articles, or content addressable by a URL. @@ -21,10 +25,12 @@ KCS articles can have embedded hyperlinks to other sources of content, such as K [Technique 3.3: Linking](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/030/030/030) ##Demo Requirements for Verified Only## -Scenario 1 +[Scenario 01](../scenario/01.md) ##OB/Config/Cust/NS/SF## - +###Out of the Box### +The Core modules 'editor' and 'ckeditor5' provide this ability. Editor allows +different WYSIWYG editors to be used. CKEditor is the default editor. ##Native Product Capability## diff --git a/docs/structure/10.md b/docs/structure/10.md deleted file mode 100644 index 966ddd7c631a2f65899089dbd7f50b766a18e61a..0000000000000000000000000000000000000000 --- a/docs/structure/10.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -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. - -##Practice/Technique## - -* Content Health -* Global Support Considerations - -##Reference: KCS v6 Practices Guide## - -[Technique 5.8: Global Support Considerations](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/040/010/055) - -##Demo Requirements for Verified Only## - - -##OB/Config/Cust/NS/SF## - - -##Native Product Capability## - -##Mechanism for Config## - -##Config Strategy## - -##Dependencies & Version Numbers## - - -##Documentation## diff --git a/docs/structure/10/index.md b/docs/structure/10/index.md new file mode 100644 index 0000000000000000000000000000000000000000..c850b07b31e6fdf03d34dacbc23ba4ca0f8be1ab --- /dev/null +++ b/docs/structure/10/index.md @@ -0,0 +1,66 @@ +--- +tags: + - Content Health + - Global Support Considerations + - 'Technique 5.8: Global Support Considerations' + - ✅ +--- + +Status: Complete ✅ + +##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. + +##Practice/Technique## + +* Content Health +* Global Support Considerations + +##Reference: KCS v6 Practices Guide## + +[Technique 5.8: Global Support Considerations](https://library.serviceinnovation.org/KCS/KCS_v6/KCS_v6_Practices_Guide/030/040/010/055) + +##Demo Requirements for Verified Only## + + +##OB/Config/Cust/NS/SF## +###Out of the Box### +During the install, the first option is which language to use. There are 118 +languages at the time of this writing. + +[List of Supported Languages](https://localize.drupal.org/translate/languages) + +There are no known restrictions to the type of languages. + + +##Native Product Capability## +Drupal Core provides four modules for Multilingual. Content Translation is used +for translating articles. + +There is a Default language, but not a Master language. If English and Spanish +are supported, and English is the default. An article in just Spanish can be +created. + +When an article is translated, all the translations have the same article id. + +##Mechanism for Config## + +##Config Strategy## +The Drupal community module, [Translation Management Tool](https://www.drupal.org/project/tmgmt), +is included but not enabled by default. It gives three translation strategies: + +1. Machine translation +2. [External translation services](https://www.drupal.org/project/tmgmt/ecosystem) +3. Local users + + +##Dependencies & Version Numbers## + + +##Documentation## +https://localize.drupal.org/ + +https://localize.drupal.org/translate/languages + +https://www.drupal.org/project/tmgmt diff --git a/mkdocs.yml b/mkdocs.yml index 64741f261b21edbdc083d11a008d838651447918..4a665eba2774a1fb7714d9ba5b53e8f0ef923ae9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,8 +11,11 @@ theme: - navigation.tabs nav: - - Home: index.md + - Home: + - 'Home': index.md + - 'References': references.md - Scenarios: + - 'Scenarios': 'scenario/index.md' - 'Scenario 01': 'scenario/01.md' - 'Scenario 02': 'scenario/02.md' - 'Scenario 03': 'scenario/03.md' @@ -30,40 +33,40 @@ nav: - 'Capture - Context': capture/02.md - 'Capture - Relevant': capture/03.md - Structure: - - '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 + - 'Structure - Article Node Type': structure/01/index.md + - 'Structure - Issue Field': structure/02/index.md + - 'Structure - Node Form': structure/03/index.md + - 'Structure - Fields': structure/04/index.md + - 'Structure - Node Types': structure/05/index.md + - 'Structure - Field Access': structure/06/index.md + - 'Structure - Basic Formatting': structure/07/index.md + - 'Structure - Lists': structure/08/index.md + - 'Structure - Hyperlinks': structure/09/index.md + - 'Structure - Multilingual': structure/10/index.md - Reuse: - - '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 + - 'Reuse - Federated search': reuse/01.md + - 'Reuse - DMZ': reuse/02.md + - 'Reuse - Linking': reuse/03.md + - 'Reuse - Linked Multiple': reuse/04.md + - 'Reuse - Delete Link': reuse/05.md + - 'Reuse - Link non KCS content': reuse/06.md + - 'Reuse - Linked Revision': reuse/07.md - Improve: - - 'Improve 01': improve/01.md + - 'Improve - Moderation Notes': 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 + - 'Improve - New Article Duplicate Check': improve/04.md + - 'Improve - Merge Duplicates': improve/05.md + - 'Improve - Edit Multiple Article Simultaneously': improve/06.md - Content Health: - - '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 - Meta Data': content health/01.md + - 'Content Health - More Meta Data': content health/02.md + - 'Content Health - Content Moderation': content health/03.md + - 'Content Health - Restrict Search by Confidence': 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 - Auto Publish': content health/07.md + - 'Content Health - Community Create/Edit Articles': 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 @@ -75,20 +78,20 @@ nav: - '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 - Search Tuning': process integration/06.md + - 'Process Integration - Indexing': process integration/07.md + - 'Process Integration - SEO': process integration/08.md + - 'Process Integration - Search Weights': process integration/09.md - 'Process Integration 10': process integration/10.md - 'Process Integration 11': process integration/11.md - Performance Assessment: - '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 - Citation Rate': performance assessment/02.md + - 'Performance Assessment - Link Rate': performance assessment/03.md + - 'Performance Assessment - Article State': performance assessment/04.md + - 'Performance Assessment - Content Standard Checklist': performance assessment/05.md + - 'Performance Assessment - Process Adherence Report': performance assessment/06.md + - 'Performance Assessment - Incident Links': 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 @@ -115,10 +118,9 @@ plugins: - search - tags: tags_file: tags.md - enabled: true 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. +copyright: KCS® is a service mark of the Consortium for Service InnovationTM. Open Knowledge is not certified by the Consortium for Service Innovation. extra: generator: false social: