Základní myšlenka struktury celého popisu aplikace je následující. Uživatel hledá aplikaci - tj. přijde sem z nějakého rozcestníku z Wiki, kde je jen odkaz a stručný popis. Z návodu se tedy musí dočíst:
SMPlayer je populární multimediální přehrávač s mnoha pokročilými funkcemi. SMPlayer představuje grafický front-end k vynikajícímu přehrávači MPlayer díky čemuž a díky svému intuitivnímu ovládání je jedním z nejpopulárnějších přehrávačů pro Linux.
Mezi zajímavé funkce patří například schopnost zapamatovat si nastavení pro každý jeden přehrávaný soubor, automatické stahování titulků z OpenSubtitles.org, podpora různých rychlostí přehrávání, široká škála nastavení polohy a vzhledu titulků, podpora mnoha jazyků (včetně češtiny) a další.
Krátký popis aplikace - dva odstavce textu se základní informací - co to je, k čemu to je, co to umí. Na začátek patří ikona programu (velikostí úměrná textu) a název programu tučně.
Screenshot aplikace. Vybírejte tak, aby vystihoval její účel. Většinou stačí jeden, ale někdy je lepší nebo dokonce nutné udělat jich více. Více se hodí u her (lepší ilustrace) a především u aplikací, kde se uživatel střetne s více okny (např. u IM komunikátoru - seznam přátel a okno konverzace.
Nainstalujte balík smplayer
Klasický případ specifické situace - instalace aplikace ze zdrojů Ubuntu - stačí vzít modelový kód a správně zaměnit nazevbaliku
.
Aplikaci můžete spustit z nabídky Aplikace → Zvuk a video → SMPlayer, případně příkazem smplayer
.
Opět klasický případ specifické situace - stačí vzít modelový kód a správně změnit „cestu“ ke spouštění
V tomto návodě není popis použití - předpokládá se, že použít videopřehrávač umí každý. Není cílem Wiki být obsáhlou příručkou veškerých znalostí a počítá se, že základní programy, které jsou vždy stejné (nějaké to play,stop atd. má každý přehrávač) již uživatel zná. Dobré je vysvětlit nějaké zajímavosti, ale to spíš v části Tipy & triky.
V tomto modelovém návodě nejsou žádné tipy pro použití aplikace - jejich přidání většinou závisí na autorovi (a také na „rozsáhlosti“ dané aplikace. Zde by se například dalo vysvětlit použití přehrávání streamů nebo nastavení titulků atp. Opět ale není cílem suplovat dokumentaci dané aplikace.
Ne všechny aplikace jsou bez problémů, drobnosti jsou všude. Pokud už je nějaký problém popsán, je zvykem popsat i řešení tohoto problému (pokud existuje). Pokud program nejde spustit nebo dokonce ani nainstalovat, je dobré na to upozornit a řešení poskytnout v patřičných sekcích výše, zde už je celkem pozdě.
Odeberte balík smplayer
.
Opět modelová situace - stačí vzít vzorový kód a změnit název balíku, který se bude odstraňovat
Základní odkazy - domovská stránka, online dokumentace, velmi dobré je odkázat na články na českých linuxových serverech (abclinux, root, linuxexpres…), kde jsou často velmi pěkné popisy. Anglické zdroje je možné uvést také, ale v rozumné míře - jsme česká dokumentace a lidé očekávají informace v češtině.