https://www.dokuwiki.org/tips:good_content

(Tipy na kvalitní obsah)

Při vytváření nové wiki stránky často pomáhá zamyslet se nad různými otázkami: Co, Kdo, Proč, Kdy, Kde; které pomohou strukturovat obsah a zajistit, že budou dostupné všechny potřebné informace.

Přemýšlejte nad těmito otázkami a kombinujte je s tipy pro dobrý styl při vytváření nových stránek ve wiki.

O co na stránce jde?/O čem stránka je?
Wiki stránka by měla vždy představit téma a uvést čtenáře do kontextu. Toho se obvykle nejlépe dosáhne v několika úvodních odstavcích

Toto je samozřejmě nejdůležitější otázka, na kterou by měla stránka odpovídat v celém svém rozsahu.

Kdo je cílová skupina?
Mějte na paměti, pro koho píšete. Například dokumentace se liší podle toho, zda je určena vývojářům nebo koncovým uživatelům.

Pokud cílíte na více typů uživatelů, můžete informace oddělit – buď pomocí různých stránek nebo jmenných prostorů, nebo pomocí různých sekcí na jedné stránce. V druhém případě umístěte informace pro větší skupinu jako první. Např. dokumentaci pro koncové uživatele před dokumentací pro vývojáře.

Příklady:

• Máme vývojářskou příručku oddělenou od dokumentace pro koncové uživatele
• Stránky pluginů někdy obsahují samostatnou sekci pro vývojáře, například plugin oauth

Proč je to tak, jak to je?
Vysvětlení historie rozhodnutí, která vedla k současnému stavu, může zlepšit pochopení daného tématu.

Příklady:

• Proč plugin Struct místo pluginu Data vysvětluje, jak vznikl plugin struct a jaké nedostatky předchozího pluginu se snaží řešit.

Kdy se obsah uplatní?
Jakékoli předpoklady, které stránka má, by měly být jasně sděleny.

Kde najít další informace?
Wiki stránky fungují na principu propojování obsahu. Zamyslete se, které pojmy na stránce by si zasloužily další vysvětlení, a vytvořte na ně odkazy. Přidejte odkazy na související obsah. Zvažte, odkud by měla být vaše stránka dostupná.

Příklady:

• Stránka s konfigurační volbou config:search_nslimit ukazuje, jak odkazovat na další pojmy v hlavním obsahu a obsahuje také sekci „Viz také“ s výčtem souvisejících odkazů.