Willkommen im neuen Forum von concrete5.de.
Wenn Sie einen Fehler entdecken oder Schwierigkeiten haben, das Forum zu bedienen, zögern Sie bitte nicht, uns zu kontaktieren: Kontaktseite

Diese Nachricht löschen?
Anhang entfernen?
FAQ Bereich? Antworten
Autor Meldung
Wombat 0.png Wombat

Hallo Fories!

Was haltet Ihr von einem FAQ Bereich? Ich begegne in sämtlichen Kanälen (concrete5.org, Slack etc.) immer wieder ähnlichen oder identischen Fragestellungen, die ganz häufig mehrere Threads / Konversationen belegen.

 

Als Beispiel:

  • Probleme mit PHP 7.2
  • MAX_EXECUTION_LIMIT bei Installation
  • Custom Single Page Themes (Login, Register)
  • Webserver-Konfigurationsvarianten
 
Ich kann mir vorstellen dass eine sinnvoll gegliederte FAQ mit guter Suchfunktion hier schon eine Lösung sein könnte. Auf documentation.concrete5.org sind die offizielle Doc, How-Tos und API Index ja alles zusammen drauf, was das Forum und den Slack Kanal aber meiner Ansicht nach nicht wirklich entlastet. 
 
Ein Bereich für How-Tos, häufige Probleme, Codesnippets und sonstige "Nicht-in-der-Core-Dokumentation-vorgesehene-Probleme" wäre also sinnvoll? 
 
Ich würde da auch gerne beim Befüllen helfen, gerade um redundante Fragestellungen aus dem Forum raus zu halten.
 
Grüßchen!
10.09.2018 21:38
Wombat 0.png Wombat

Grade witzig bemerkt, falls jemand den Editor hier mal abcheckt: Nach der <ul> wurde meine Text nicht mehr in <p> gewickelt sondern in <span> mit font-size: 16px als Styleattribut. Special Effects :-)

10.09.2018 21:40
admin 0.png admin

Ja das Problem ist mir bekannt, da arbeite noch dran, leider finktioniert die Möglichkeit was anzuhängen nicht mehr. (Wir haben auf 8.4.1 aktualisiert).
Die Probleme werden aber heute behoben.

11.09.2018 07:58
admin 0.png admin

Ich finde die Idee eine FAQ nicht schlecht, woran hast du gedacht?
so was: https://www.concrete5.org/marketplace/addons/advanced-faq
Oder hast Du wo anders was gesehen was wir nachbauen könnten?

11.09.2018 08:13
Wombat 0.png Wombat

Ich würde ein FAQ auf jeden Fall durch das normale "Seiten" Modell realisieren, um Arbeitsabläufe (mehrere Autoren) Versionen usw. realisieren zu können. Also alles C5 Bordmittel, denen mit entsprechenden Templates die passende Struktur verpasst wird.

 

Wichtig sind IMHO die passenden Tags, ein Suchformular und übersichtliche Gliederung. 

Die concrete5-Tutorials hier sind eigentlich gut gegliedert. Ich kann grade keinen Link einfügen, da der <a> scheinbar nicht geschlossen wird. 

Ich mache mir mal Gedanken über eine sinnvolle Gliederung (FAQ, How-To, Snippets) und komme mit einem Entwurf daher, ok?

 

11.09.2018 08:26
Wombat 0.png Wombat

Ok, ich habe mal etwas nachgehirnt über Struktur für FAQ etc.

1. Der größte Nenner der getrennt werden muss ist für v5.6 und v.7+ (v8+), da hier keine Rückwärtskompatibilität besteht, ggf. aber durchaus Material zusammen kommt. Es braucht also drei getrennte Bereiche, welche eigene Strukturen im Seitenbaum haben um getrennte Suchen zu ermöglichen, die den jeweils anderen Bereich nicht tangieren.

 

2. Ich würde in jedem Falle das "Seitenmodell" verwenden um via Arbeitsabläufen die Community (Autoren, Redakteure etc.) einbinden zu können. 

3. Ich würde drei getrennte Bereiche machen: FAQ, How-Tos und Snippets

3.1: FAQ 

FAQ sollten thematisch getrennte Überbereiche sein wie es auch hier schon gelöst habt: https://concrete5.de/dokumentation-Concrete5

Wobei ganz oben eine Suchleiste stehen sollte. Die einzelnen FAQs sollten in ihren Strings auch die typischen Frageformulierungen haben um über die Suche gut gefunden zu werden. Ob die C5-eigene Suche da ideal ist oder eine semantische Suchengine besser wäre, kann ich nicht sagen, muss aber evtl. nicht sofort umgesetzt werden. 

Ein FAQ-Element besteht also aus einer Fragestellung und der dazugehörigen Antwort, ideal auch mit Kommentarfunktion um Ergänzungen zu ermöglichen. Die Kategorisierung der FAQ-Elemente sollte nach dem vom User zu beobachtenden Problem erfolgen wie "Plötzlich ist meine Seite weg" oder "Nach Update kommt ein Fehler" oder "Ein neues Theme und etwas geht nicht mehr".

In der jeweiligen Kategorie sammeln sich dann die diversen Möglichkeiten und Lösungen an, die "FAQs" ja durchaus begrenzt sein sollten.

 

3.2: How-Tos

How-Tos müssen anderweitig organisiert werden, eher wie die How-Tos auf documentation.concrete5.org gelistet sind, da diese ja potenziell unbegrenzt viele werden können. 
Ein How-To muss eine eindeutige Versionskennzeichnung haben ("bei dieser Version geht es so), nach der auch gefiltert werden kann (Topics evtl.?) Es muss allerdings klar sein dass ein HowTo auch bei einer anderen Version funktionieren KÖNNTE, wir können es den Autoren jedoch nicht zumuten dies für alle Versionen zu testen. Die Sortierung sollte hier nach "Jüngste, Älteste, Beliebteste" erfolgen. Eine Kommentarfunktion erscheint mir hier auch sinnvoll. Wenn ein HowTo eine Übersetzung einer Anleitung wo anders ist, sollte die Quelle genannt werden. HowTos können Textform haben oder Videos also Screencasts.

Man könnte noch eine Kategorisierung via Tags vornehmen, welche die HowTos als "Basics" (z.B. Composer-Install, Mysqldump von CLI, Migration auf anderen Server etc.) oder als "Anpassungen (z.B. "Single Page Custom Design", "Template Overrides" etc.) kennzeichnet.

3.3 Snippets

Ich würde mir noch einen Bereich mit Codeschnipseln wünschen (Cheat-Sheet), im Sinne von https://www.webli.us/cheatsheet/doku.php

nicht, um das Rad neu zu erfinden sondern um nützliche Snippets (streng getrennt nach Version!) sinnvoll zu konservieren und als Teil der Communityseite zu integrieren. 

 

Design

Wir sind hier ja im Bootstrap-Land und können die vorhandenen Style-Elemente gut ausnutzen. Als oberste Navigation würde ich zwei untereinanderstehende Horizontal Tabs machen. Die obere Ebene zur Versionswahl (5.6 / 7+), direkt darunter ein Tabmenü mit den Möglichkeiten FAQ/HowTo/Snippets in angemessenen Worten. Unterhalb dieser "Bereichsebene" beginnt die Möglichkeit mit Suchfeldern zu arbeiten und auch die Gliederung der Elemente in "Kategorien in Boxen" (wie jetzt Doku) oder "Filterbare Liste" (wie concrete5.org doku). Die Codeschnipsel können evtl. als Tabelle sinnvoll angelegt werden mit Zweck / Code / Version Spalten.

 

Ihr könnt mir auch einen abgesperrten Bereich einrichten, dann kann ich das schon basteln als Entwurf. Ich würde das FAQ auf jeden Fall im Rahmen der Userauthentifizierung der Community hier laufen lassen um Mitgliederbeiträge zu ermöglichen (ein admin allein schafft das nicht).

 

Guten Morgen :-)

12.09.2018 08:30
Wombat 0.png Wombat

Danke :-)

16.10.2018 15:21
admin 0.png admin

PN!

16.10.2018 15:35

Nachricht hinzufügen