Skip to content
gaurav-sharma-snaphunt edited this page Mar 2, 2020 · 6 revisions

Snapi

About Snaphunt

Snaphunt is a predictive hiring platform that finds and matches talent to jobs for a skill and personality fit. They help people find jobs they love and companies hire employees who stay longer.

Objectives

Create a knowledge management system for a new Help Center module that will enable Snaphunt users to quickly find detailed guides of the platform’s features.

The purpose of the Help Center Management Tool (HCMT) is to facilitate content creators in creating standardized content and make this content available to content consumers in the same standardized format as it was created.

Alternatives

There are various proprietary and open source solutions available for knowledge management software. Some examples include, Helpjuice, Zendesk, eXo.

Snaphunt has done extensive research on using alternative software solutions and have concluded that building their own platform would better fit their needs.

Personas

Wilson, Technical Writer

Wilson is a technical writer who will add content to the Help Center. He is familiar with using a WYSIWYG editor to add content.

Daphne, Developer for Help Center

Daphne is a developer who works on the Help Center.

Project components

The Snapi project consists of three parts:

  • Snapi (short for Snaphunt API)
  • Reader
  • Editor

Snapi

A RESTful API service that is able to serve both content creators and content consumers resources for the Help Center.

This service must be able to limit access to its API given the types of users accessing its endpoints. In general, content consumers should have read-only access to these resources, while content creators should have the ability to read, add, edit, and remove resources where necessary.

For content consumers, APIs should be designed such that content can be filtered depending on input criteria. For eg, retrieve a list of all categories with their associated topics only, retrieve all topics, subtopics and content within one or more categories etc.

Reader

User: content consumer

The purpose of this application is to demonstrate how we can consume the API from Snapi. It is a frontend application built in React. This application simulates how data can be retrieved from JSON format and presented in HTML with rich text formatting.

This application should only have GET access to the resource endpoints.

Editor

User: content creator

This is a frontend application with a rich text editor that allows editors to read, add, edit, and remove content which will be consumed by readers.

We may use the CKEditor WYSIWYG component for rich text editing. The inline editor mode should be used in this project.

Link to the editor page UI: https://snaphunt-my.sharepoint.com/:b:/p/gaurav_sharma/EbtKOuj6NWNKm4BbPpShR9wBeTChpqtVt83ZIj5p9b7rlA?e=kUlWSO

This application should have GET, POST, PATCH, and DELETE access to the resource endpoints.