12. Deset zásad pro tvorbu dokumentace na www.technickakomunikace.cz/blog + zpětná vazba :-)
Notes de l'éditeur
potřeba „odpíchnout se“ – zjistit, pomůže změna kontextu i v domácnosti používáme dokumentaci, někdy, pravda, putuje rovnou do kamen úspěšná dokumentace je, když používám „její objekt“ (tedy i neexistující nebo spálená dokumentace, pokud je objekt dostatečně user-friendly)
chtěli jsme hrát hru, na kterou manželka nostalgicky vzpomínala po 1,5 hodině čtení návodu jsme to vzdali a radši šli spát ...jde taky o technickou dokumentaci ...ale něco je špatně výhoda byla v tom, že jsme si mohli vybrat (používat, nepoužívat) – to neplatí vždycky někdy člověk prostě „musí“
nejlepší dokumentace je ta od „experta“ pro stejného „experta“ problém s dokumentací v naší sféře je často ten, že ji píše „znalý“ pro „netušícího“ samozřejmě by se měl snažit překonat bariéru a v nejlepším případě se vžít do pozice uživatele --- ale ani já za dva roky nebudu to samé, co já teď… je to možné? spíš ne. jak na to? nedá se nějak „sloučit“ pozice znalce a neználka? ajtíka a lamy?
jak překonat rozdíly? klon ajtíka a lamy? asi ne. Mohla by nám ale pomoci změna kontextu. Co když někde jinde (mimo počítač) i já jsem ta „lama“?
Doma! (někdy) A kdy?
Nebo alespoň o jeho praní. Skutečný problém je spíš v sofistikovaném třídění druhů prádla než v obsluze pračky (samotná je jednoduchá).
Praní prádla má svá specifika, podobná mnohým jiným aplikacím a zařízením: Mám jednoznačný cíl. Neznám způsob, jak se k němu dostat. Nemám čas a chuť nad tím koumat. Nic jiného mě na té věci nezajímá! (nechci se stát expertem na prádlo ani nechci, aby mi žena vysvětlovala logiku věci)
Malá odbočka: jsou i jiné aplikace, které kladou na uživatele i na dokumentaci jiné nároky ovšem proto, že i uživatel má na ně jiné nároky… taky např. Photoshop
Co potřebuju v případě aplikace typu „praní prádla“? zobecňující návod jednoduché use casy a konkrétní postupy k nim !!! ne vysvětlení logiky věci
Toto byl výsledek u nás doma: vytvořený na míru expertem pro konkrétního uživatele a jeho potřeby… Klíčový efekt: přestal jsem se pračky bát a rád ji používám (win-win řešení na všechny strany)
na dokumentaci často pracujeme pod tlakem (málo času, málo peněz…) proto vzniklo toto ponaučení: dobrá minimalistická dokumentace poskytne: řešení, jak se co nejrychleji dostat ke konkrétnímu nejčastějšímu cíli všechno ostatní je „nice-to-have“ výsledkem je návod na rychlou dokumentaci v 10 bodech (viz web www.technickakomunikace.cz)
![[object Object],[object Object],[object Object]](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)