Toto je starší verze dokumentu!


Jak psát wiki články aby byly snadno srozumitelné pro druhé?

Psát dobré wiki články tak, aby byly snadno pochopitelné pro nezasvěcené a užitečné i pro zasvěcené je poměrně těžké. Pokusím se sepsat zásady se kterými můžete nebo nemusíte souhlasit. V každém případě by vás mohly inspirovat a budete mít trochu přehled podle čeho články hodnotím.

Jednoduchost

Méně je někdy více. Vlastně né někdy ale velmi často. Pokud se vám problém zdá přiliš složitý, možná na něj nemáte ten nejjednodušší možný pohled. Pokud se vám zdá něco příliš složité, je to patrně proto, že si to neumíte náležitě zjednodušit. I složité věci je možné popsat jednoduchými a zřejmými příklady. Je to obtížné a často zdlouhavé, ale vyplatí se to.

Psát složitě o složitých věcech umí kde kdo (a často je dělá ještě složitějšími). Psát jednoduše o složitých věcech je umění, které ale stojí za to.

Konkrétnost

Směr od konkrétního jednoduchého příkladu k abstraktnímu pravidlu je snáze uchopitelný než obráceně.

Stručnost

Je-li textu příliš mnoho, podstatné myšlenky zůstanou skryty. Chytrý čtenář si jistě se stručným a výstižným textem poradí. Ale zbytečně rozvláčný text by jej mohl odradit a ztracenému stejně nepomůže. U každé věty je třeba se zamyslet. Říká něco opravdu podstatného? Byla by hlavní pointa zřejmá i bez ní? Je možné tuto informaci snadno najít jinde nebo se průměrný čtenář dovtípí?

Jeden přehledný obrázek nebo schéma (i zjednodušené) je za tisíc slov.

Udělat několik snímků obrazovky nedá téměř žádnou práci a text velmi oživí. Ale nepřehánějte to.

Jednoduše - bez odborných výrazů

Je-li zde předpoklad, že čtenáři neznají některý z používaných odborných výrazů, snažíme se základní pointu vysvětlit nejdříve bez nich, až poté s nimi. Je třeba psát jazykem, který je srozumitelný lidem pro které je článek určen. Začátečníků je vždy mnohonásobně více než expertů - pišme tedy především pro inteligentní začátečníky. Odborné výrazy jsou většinou přesnější, ale pochopení nováčkovi ztěžují. V této souvislosti nevadí, když se dopustíme mírné nepřesnosti, na kterou můžeme v závěru - je-li třeba - poukázat.

Ostatně pokud by čtenář chtěl více přesných informací, stačí si přečíst manuálové stránky nebo jinou „přesnou“ dokumentaci.







Hlavní body z knížky s názvem : Jak zaujmout hned napoprvé

Nečekanost

Pozornost zaujmeme tím, že čtenáře překvapíme. Co je to překvapení? Překvapení je stav mysli (často i s otevřenou pusou), v kterém se mozek naladí na přijímání nových souvislostí a informací tak, aby si nové a nečekané dovedl nějak zařadit. Přesně to potřebujeme.

Konkrétnost

Abstrakce je pro začátečníka jen nehorázné plácání nesrozumitelnými termíny. Lidé, kteří hodně vědí, jsou „prokleti věděním“ a vyjadřují se v nesrozumitelných pojmech dobře známých jen jim samým. Je třeba mluvit jazykem našich posluchačů.

Věrohodnost

Věrohodnost získáme pomocí demonstrace konkrétních ověřitelných příkladů.

Emoce

Emoce jsou energetickým palivem člověka. Bez emocí není nic. Je tedy nutné zaujmout.

Příběh

Pamatujete si ještě, proč se Newton začal zabývat gravitačními zákony? Jednoho dne mu spadlo v zahradě jablko na hlavu a tak o tom začal přemýšlet. Příběhy se velmi dobře pamatují a vtáhnou posluchače do děje, aby se chtěli dozvědět jak to bude dál.

Troubleshooting - řešení problémů

Každý krok by měl navíc ukazovat jak poznám, že ten předchozí se provedl OK. Začátečník tak může snadno zjistit, v čem je problém, pokud se přestane dařit. Zkušený uživatel se vyznačuje hlavně tím, že ví jak se zachovat v případě, když něco nefunguje tak jak má a dovede to rozpoznat. K tomu by návody měly být také užitečné a je třeba to mít na paměti.

Zákon dávání a braní

Nesouvisí to přímo s psaním wiki článků, ale souvisí to tak trochu se vším. Abych si mohl něco vzít, musím nejdříve něco dát. Myslím že tohle platí naprosto obecně. Důležité je jen dávat to, co lidi opravdu chtějí a potřebují a nic za to nečekat. Revanšovat se někomu kdo hodně dává je přirozené a lidské. Hodně dávat není slabost, ale je to doména silných. Přestože se to možná nezdá, ale nakonec vše tito silní dostanou od druhých zpět - proto jsou silní. Samozřejmě se člověk nemůže celej rozdat ale i tak je na této myšlence hodně moudra - je to snad i ekonomická poučka, která ale v dnešní době zapadá. (Musím dát zákazníkovi dobrou službu, abych zákazník nebyl lakomý mi nějakou tu korunu nechat vydělat - funguje to tak)

 
jak_psat_wiki_clanky.1313134353.txt.gz · Poslední úprava: 2011/08/12 09:32 autor: xsouku04