Knowledge

The area Knowledge is the manual your own team writes and keeps: guides for working in plinth and in the Shopware backend, a glossary, checklists for new colleagues and news about changes. It also holds the reports people send with Report a problem. The help panel you open with F1 shows pages from here.

Where to find it

• Help and administration > Knowledge. The address is /s/<shop>/knowledge.
• The menu on the left of the area has: Overview, First steps, Glossary, What's new, Reports and, below Pages, the help pages.
• The help panel: press F1 on any page. See The basics.

What you need

Everybody with access to the shop can read, search, tick checklists and send reports. Writing needs a permission:

How do I find a guide?

1. Open Help and administration > Knowledge.
2. Type into Search knowledge at the top left. The results list matching pages. If nothing matches, you see Nothing found for with your search term.
3. Or browse: Manual shows the collections of pages, Recently changed the pages that were edited last.
4. Open a page. Below the text you find Subpages, Related pages and Pages linking here.

The search in the top bar (Ctrl K) also finds knowledge pages, in the group Knowledge.

A page marked Company applies to all shops. A page without that mark belongs to this shop only. A page marked Template was delivered with plinth; team leads can adapt it to their way of working.

How do I look up a term?

1. Open Knowledge, then Glossary.
2. The list shows each term with its definition.

In help pages, glossary terms have a dashed underline. Hover over one to read the definition.

How do I use the getting-started checklists?

1. Open Knowledge, then First steps.
2. You see the checklists For everyone and those for your role.
3. Work through the steps. Tick a step when you have done it. Guide next to a step opens the matching help page.

Your ticks are your own. Other people do not see them.

How do I see what is new?

1. Open Knowledge, then What's new.
2. The newest entries are at the top.

A small dot on the help button in the top bar shows that there is an entry you have not seen yet.

How do I follow up on a problem I reported?

1. Open Knowledge, then Reports. You see My reports with the columns Title, Area, From, Status and Date.
2. Filter by status with the buttons at the top.
3. Click a report to open it. You see your text, the screenshot and the Comments.
4. To answer a question, write under Write a comment and click Send comment.

To send a new report, click Report a problem on this page or in the account menu. See The basics.

How do I work the inbox of reports?

This needs the permission Handle reports in the inbox.

1. Open Knowledge, then Reports. With this permission the page is called Inbox and shows the reports of everyone.
2. Open a report. Context shows the Page it was sent from and the Browser.
3. Write a comment if you need to ask something or explain a decision.
4. Choose the new Status on the right and click Save.

How do I write or change a help page?

This needs one of the two writing permissions.

1. Open Knowledge and click New page, or open a page and click Edit.
2. Enter the Title.
3. Choose the Type (Guide, How-to, Reference or Collection) and the Area (In the tool, In the Shopware backend or Tool and backend).
4. Optional: choose a Parent page and the Order among its siblings.
5. Under Applies to choose This shop only or Company-wide (all shops). The second needs the company-wide permission.
6. Write the text under Content (Markdown). The buttons above the field insert headings, lists, links, tables, callouts and images. Preview shows the result. You can add images with the button, by pasting or by dropping them.
7. Optional: under Belongs to, enter where the page should appear as help, one entry per line. The help button then opens this page there.
8. Optional: under Only for roles, restrict the page to certain roles. Leave it empty to show the page to everyone.
9. Optional: write a Change note.
10. Click Save.

While you edit, the page is locked for others. They see that you are editing and cannot save.

How do I see or restore an older version of a page?

1. Open the page and click History.
2. Click a version. You see how the page looked and the changes compared to the previous version. Compare with current shows the difference to the current page.
3. To go back, click Restore this version. This creates a new version with the old content; nothing is lost.

How do I add a glossary term, a checklist or a news item?

• Glossary term: open Glossary and click Add term. Enter the Term, optional Other spellings (comma-separated) and the Definition. Click Save.
• Checklist: open First steps and click Add checklist. Enter a Title, optionally a Role (empty = all) and the Steps, one line per step. Click Save. Manage all checklists shows the lists of all roles.
• News item: open What's new and click Write news item. Enter Title, Date and the text, then click Publish. Keep it short: what's new and what it means for daily work.

Warning: Deleting a checklist also removes everybody's ticks in it.

Common errors and fixes

See also

• The basics
• Glossary
• Access
• Getting started