Knowledge Management System Editor

The KMS Editor offers a basic set of Markdown tools to capture project requirements through User Stories, Requirements, Illustrations and tabular reference data.

In addition, the solution, combined with the KMS Core, provides a solution to generate Word (docx) document sets and inject full requirement sets into Confluence while generating the supporting Jira issues simultaneously.

KMS was created to facilitate community authoring with a focus on content reuse and automation while keep operating costs low.

Fig. S2CKAB - Example of the KMS Plugin menu options

Setup

Setting up the connection to Atlassian Cloud is not required, but it can save many hours of time when sharing requirements with your development team. To setup your Atlassian connection, please follow these Instructions

Functions

Insert Front Matter

Injects the metadata required for any topic in the Knowledge Management System. All topics require Front Matter

---
id: RVFD7I
title: Branding
tags: 
component: 
topictype: Requirement
wikiid:
jiraid: 
---

Example of a Topic Front Matter

• id: the unique ID of the topic, generated by the KMS Plugin. This ID is used to reference the topic in publications and in Confluence
• title: The title of the topic
• tags: Topic tags, used in Confluence to identify common topics
• component: identifies the component that this topic targets. it is based on the specific Jira project.
• topictype: Type of topic, one of the following options:
  • Epic: Set of deliverables or Work packages
  • Reference: Used to define an existing system and/or process
  • Notes: Meeting Notes
  • Requirement: Business Requirements
  • Change Request: Request to develop or modify application functionality

Insert User Story

Walks the user through a set of menus to create a User Story object

## UC-CTRRG0RS - Corporate Branding
`Extension|M|W`

As a `System User` I need to be able to see a branded view of the application so that the corporate-approved themes can be used throughout the application.

Sample User Story

After the user has selected the configuration for the User Story, the KMS Plugin will insert the story structure

• '## UC-CTRRG0RS' : The unique identifier for the story
• '`Extension|': The classification for the user story
  • Type:
    • Extension - Custom develop
    • New - A New feature that should be considered for inclusion in the base product
    • Base - Included in the current base product
    • Integration - Integration with another system
• '|M|': The T-Shirt size for the story
  • Small - A Day
  • Medium - A Week
  • Large - A Sprint
  • XLarge - 2x Sprints
  • XXLarge - More than 2 Sprints
• '|W`': Platforms
  • Web
  • iOS
  • Android
  • Service

Insert Requirement

Inserts a new Requirement ID that can be used to support and define a User Story

### REQ-S2CJCN - {Title}
{description}

Example Require structure, the user is responsible for adding the title and the description

Insert Image

![img:::img](https://github.com/m-ize/KMSPlugin/raw/HEAD/wwwroot/images/placeholders/img.png)

*Fig. S2CJAE* - Figure 1

Example image structure

Paste Clipboard Image

• Pastes the current image on the clipboard and creates a new file in the target folder

Insert Fragment

Inserting a fragment will insert another topic at the specified point of the fragment allowing for maximum reuse of content

!(ADE3GE)

Fragment Example

Insert Table

Inserts a standard Pipe Grid

|one|two|three|
|---|:-:|--:|
|Value 1|Value 2|value 3|

*Table S2CJHL* - {Table Description}

Insert Link

Inserts an external Link

[CNN Website](https://www.cnn.com)

Insert Task

Inserts a new Task

- [ ] New Task

Insert Error

Inserts an Error info panel into the markdown file. When the topic is published to Confluence, it will appear like the following:

Fig. S2CK0T - Error info panel example

Insert Information

Inserts an Info panel into the markdown file. When the topic is published to Confluence, it will appear like the following:

Fig. S2CK24 - Information panel example

Insert Note

Inserts a Note info panel into the markdown file. When the topic is published to Confluence, it will appear like the following:

Fig. S2CK37 - Note information panel example

Insert Warning

Inserts a Warning info panel into the markdown file. When the topic is published to Confluence, it will appear like the following:

Fig. S2CK40 - Warning information panel example

Publish

• Pushes topic values to Confluence and injects User Stories into Jira
  • Requires the KMS Core System

Build Word Docx

• Generates a Word document using a preset template
  • Requires the KMS Core System

this come from thet top of the the page Test and then wraps around