Skip to content

This is an overview and guidelines of how to use the Knowledge Base

Notifications You must be signed in to change notification settings

VokkeSoftware/Knowledge-Base-Overview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 

Repository files navigation

Vokke's Knowledge Base

Welcome to Vokke's Knowledge Base.

This is an overview of what the Knowledge Base is and how you can use it

Overview

What is a knowledge base? Essentially, it is a central resource where we capture and communicate knowledge.

Philosophy

Our Knowledge Base is:
  • A living, breathing resource
  • Open to all team members to contribute to
  • Simple and easy to navigate

Using the Knowledge Base

Resources are stored in repositories. Each repository relates to a particular skill or a general topic. For example, we have a repository dedicated to software development processes and another one for company-wide processes (Team PlaybooK).

What belongs in the Knowledge Base

Standards, guidelines and processes that document how things are done at Vokke.

Contributing to the Knowledge Base

To ensure that valuable content is created, the following standards should be followed when developing a resource for the KB.

Naming conventions

Our GitHub account is also used as part of our development process so to ensure that anything related to our Knowledge Base can be easily located in the future or by other users, the following naming convention must be followed:

Repository title= "Knowledge-Base-Title"

Language should be clear and concise

Wiki

How to use the wiki feature

Slack integration

We can integrate Slack with the Knowledge Base so the team gets real-time updates when questions are asked or answered.

About

This is an overview and guidelines of how to use the Knowledge Base

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published