From f5bffcf7c30114b4bd4ac1b2048bb7d032245e2e Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Tue, 21 Mar 2017 10:17:14 +0100 Subject: [PATCH] Created more module descriptions --- Docs/introduction.md | 51 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 Docs/introduction.md diff --git a/Docs/introduction.md b/Docs/introduction.md new file mode 100644 index 0000000..6b196c1 --- /dev/null +++ b/Docs/introduction.md @@ -0,0 +1,51 @@ +# Introduction + +The **Knowledgebase** module can create `wiki` like articles to share information (e.g for new employees, FAQ for customers etc). + +## Target Group + +The target group for this module is someone who would like to share information internally with employees, team members or externally with customers/supplierer. + +# Setup + +The module can be installed through the integrated module downloader and installer or by uploading the module into the `Modules/` directory and executing the installation through the module installer. + +The module is depending on the **Editor** module which provides most of the writing features. + +# Features + +## Categories + +Wiki articles can be grouped by categories which can have subcategories. + +## Badges + +Every wiki article can have multiple badges indicating the type of the wiki article. + +## Localization + +Wiki articles can be written in different languages and made visible to people who have the same localization setting. + +## Markdown + +The module makes use of an extended markdown version for easy writing and modifications. + +### Extendability + +Modules can provide custom elements which allows them to provide elemnts that normal markdown doesn't support. Some modules that already provide custom elements for articles: + +* Media +* Charts +* Spreadsheets +* Calendar/Events +* Tasks +* Checklists +* Profiles/Contacts + +# Recommendation + +Other modules that work great with this one together are: + +* [Editor](Editor) +* [QA](QA) +* [Support](Support) \ No newline at end of file