Přepracování FAQ a Troubleshooting

Jan Tvrdík

V současné době existují dvě velmi podobné stránky

Obě mají být součástí oficiální dokumentace. Tedy FAQ je na špatné doméně. Zatím jsem ji ale nepřesouval, protože těch problémů je tam víc.

Zkusím stručně shrnout, jaké by měly být mezi FAQ a troubleshooting rozdíly (viz centrální bod ideologie).

FAQ = odpovědi na nejčastější dotazy, délka odpovědi nesmí přesáhnout dva odstavce
Troubleshooting (knowledge base) = sbírka řešení běžných problémů, problém & jeho řešení jsou na samostatné stránce (příklad)

Stránky bohužel tomuto konceptu neodpovídají. Troubleshooting je v podstatě FAQ a některé otázky z FAQ by zase měly být vyčleněny na samostatnou stránku v rámci troubleshootingu.

Tomáš Votruba

FAQ i Troubleshooting mi trochu splývá („odpovědi na nejčastější dotazy“ = „sbírka řešení běžných problémů“), jediný rozdíl je tedy v délce popisu řešení, což mi přijde jako divné kritérium. Nějaké FAQ bude potřebovat kvůli nové API rozšířit o 10 znaků a už jej musím zařadit do Troubleshooting, ejha.

S ohledem na stáří ideologie a vývoj frameworku bych byl pro jednu stránku, s tím, že z důvodu přístupnosti by dlouhé návody byly na proklik. Stejně tak by pro mě jako odpovídajícího bylo jednodušší odkázat na FAQ a nemuset procházet 2 stránky a pamatovat si délky jednotlivých odpovědí.

Také by se mi líbilo analogicky stejné rozdělení do témat dle dokumentace a Planette. Už to funguje a dobře se v tom prochází (předpokládám nám i nováčkům), narozdíl od současné podoby FAQ, kde je to řazeno nejspíše dle chronologie přidávání.

Také si nedokážu představit reálný příklad takového Troubleshooting v Nette, abych si řekl, jo, tohle už není FAQ.

tl;dr;

Problém vidím v pochybném kritériu rozlišení návodů na tyto stránky. Tj. buď jasně specifikovat, nebo sloučit, nic mezi, co by mohlo vyvolat spory či nejasnosti.

Dále mne napadá:

Jak se takový Troubleshooting píše? Vezmu jeden konkrétní problém, který někdo popisoval na fóru a dlouho řešil? Sloučím všechny možné problémky např. u přihlašování?
Jak by se udržovala aktuálnost? Než jsem FAQ nedávno upravoval, bylo tam dosti starých návodů (= k ničemu). Na to je vzhledem k oficiálnosti stránky dát pozor.

Asi už máš nějakou představu, tak ji zatím vytvoř na devu, ať se můžeme bavit o konkrétních věcech a commitovat :) je lepší něco udělat na devu a pak jen přesunout, než se neefektivně bavit o tom, jak bychom to mohli udělat.

Jan Tvrdík

Úplně jasnou představu nemám, ale hlavně nemám čas to teď řešit. Kdybych do měsíce nezačal (nebo někdo jiný), tak do mě kopni.

Tomáš Votruba

Schmutzka kicks Jan Tvrdík: Tož kde se flákáš? Jsem ti k dispozici, budeš-li potřebovat.