Documentation Process Overview

This help system describes the process the Documentation Team uses to:

• Update the online help for the Syniti Stewardship Tier (SST)

• Update the online help for the Syniti Knowledge Platform (SKP)

• Update the online help for the Installation and Configuration Guides

• Add Field and Page Level Help for the Knowledge Platform

• Update Syniti Replicate Documentation

• Update the standards and processes (this system)

The process for updating each of the projects above is similar: All are created as Flare HTML5 output, then made available on a dev site for Tech Writer peer review. Finally, the help systems are copied to a prod site for user access.

The differences in the process are:

• The names of the repos in our Github source control

• The process to move the files in the help system to the dev and prod environments

Additionally, as we have time, the Doc team:

• Adds articles to the KB

• Adds posts to Data Insiders

• Reviews cConnect Posts to Add to Data Insiders

Update SST Quick Start

Git branches: develop_nnn where nnn is the version number of the release

How to get your changes in dev and prod: Merge your changes to the develop_nnn branch then build in Jenkins

Perform steps in:

1. The Documentation Status Field

2. Workflow - Not Started

3. Workflow - In Process

4. Workflow - Review

5. Workflow - Approved

6. Update Online Help in Flare

7. Update Help on Dev and Prod Sites

8. Workflow - Peer Review

9. Workflow - Doc Done

Update SKP Quick Start

Git branches: develop and master

How to get your changes to dev and prod: In Github, merge your changes to develop branch then merge the develop branch into the master branch

Perform steps in:

1. The Documentation Status Field

2. Workflow - Not Started

3. Workflow - In Process

4. Workflow - Review

5. Workflow - Approved

6. Update Online Help in Flare

7. SKP Help

8. Workflow - Peer Review

9. Workflow - Doc Done

Update Installation and Update Guide

Git repo and branches:

• dsp-install-manuals

• Stagingnnn where nnn is the version number of the release

To build your changes in dev and prod, merge your changes to the Stagingnnn branch then build both versions in Jenkins using the same steps as the SST.

Update Documentation Standards and Processes

Git repo: main

How to get your changes in dev and prod: Refer to this topic for more information Update the Doc Team's Process and Standards

Perform steps in:

1. The Documentation Status Field

2. Workflow - Not Started

3. Workflow - In Process

4. Workflow - Review

5. Workflow - Approved

6. Update Online Help in Flare

7. Update the Doc Team's Process and Standards

8. Workflow - Peer Review

9. Workflow - Doc Done

 

Help build date: 05 22 2023 02 05