Struktura dokumentů - studie, koncepce, zadání, ...

Úvod

Vytvořit dokument, který bude přehledný, přiměřeně strukturovaný a úplný bychom se sice měli naučit již na základní škole (slohové práce) a rozvíjet na vyšších stupních vzdělání (absolventské, bakalářské práce apod.), nicméně se ukazuje, že je to pro většinu lidí značný problém a to nejen pro absolventy, ale i o starší ročníky s léty praxe.

V rámci mé praxe musím dnes a denně vytvářet řadu dokumentů, které slouží nejen pro mé klienty a partnery, ale i pro vnitřní využití v rámci organizací, pro které pracuji. Při tvorbě každého z dokumentů se potkávám s otázkami a diskusí, jak má vlastně dokument vypadat a velice často se vymýšlí struktura a obsah znovu, znovu, ........

Řada firem a organizací si tuto situaci (a problém) uvědomuje a vytváří sadu tzv. šablon pro různé situace, kde je již struktura a část obsahu předepsána a značně usnadňuje tvorbu dokumentů. Sám jsem zastáncem tohoto přístupu, nicméně i šablonu je třeba vytvořit, málokdy ji lze převzít beze změn a nastávají situace, kdy je třeba vytvořit dokument nový a/nebo upravit dokument cizí.

V tomto článku nabízím krátké zamyšlení, jak navrhnout strukturu a obsah dokumentu. V dalším textu jsou uvedeny některé principy a pravidla, kterými se při tvorbě dokumentů řídím.

Stať

Základní osnova: Úvod, stať, závěr

Již na základní škole se píší slohové práce, kde do nás učitelé nutí si vypracovat osnovu slohové práce se základními stavebními kameny a to "Úvod", "Stať", "Závěr".

Tyto základní stavební kameny platí i pro jakýkoliv jiný připravovaný dokument, i kdyby daná část měla mít jen jedinou větu. Asi vám přišlo zvláštní zvýraznění těchto částí v tomto článku, nicméně jsem učinil záměrně, aby bylo zřejmé, že tuto základní osnovu dodržuji.

Co už si ze základní (ani jiné) školy nevybavuji, že by nám učitelé řekli a co já doporučuji, aby i každá kapitola v dokumentu měla Úvod, Stať a Závěr (opět platí, i kdyby měly jednu větu).

Stručný účel jednotlivých částí:

1. Úvod: slouží ke stručnému vymezení předmětu/tématu, kterému se bude stať zabývat. V případě dokumentu se jedná o stručný popis celého tématu, v případě kapitoly uvádím (třeba jednou větou) účel kapitoly.
2. Stať: Vlastní text dokumentu nebo kapitoly
3. Závěr: Stručné shrnutí výsledků, ze předchozího textu, zdůraznění výsledků, případně důležitých upozornění vyplývajících z předchozího textu.

Proces řešení problematiky

Komplexní dokument zpravidla slouží pro (popis) řešení nějakého problému (problematiky). Řešení problémů (problematiky) má taktéž své zákonitosti a to

1. Znalost výchozí (stávající) situace - jedná se např. o popis stávajícího způsobu řešení problematiky, postupy, okolnosti, lidi, problémy apod.
2. Představa o cílovém stavu - čeho se chce dosáhnout (případnou) změnou (mám rád změnu :-) ). V rámci dokumentu nutně nemusíme dojít ke změně, ale je to obvyklé. Pokud ke změně nedojde, je třeba velmi dobře zdůvodnit.

Z toho vyplývají základní požadavky na dokument:

1. Analýza
   1. Popis výchozího stavu / situace, popis okolí (např. legislativa, okolní projekty) a význačných parametrů, problémy stávajícího stavu
   2. Cílový stav - požadavky na cílový stav, sběr a analýza požadavků, doplnění informací k cílům, kritéria úspěšnosti, apod.
2. Syntéza
   1. Návrh možných (rámcových) variant řešení - varianty dosažení cílů, splnění požadavků apod. Minimálně existují dvě varianty a to, tzv. "nulová" ~ nedělat nic, 1 ~ jakákoliv akce (podle počtu možných akcí se vznikají další varianty)
   2. Výběr nejvhodnější varianty - způsob hodnocení a výběru varianty je téma na samostatný článek….
   3. Zpracování (detailního) návrhu řešení - rozpracování vybrané varianty do návrhu řešení, posouzení možnosti využití lepších hodnocení jiných variant v dílčích kritériích apod. Obecně se jedná o nejrozsáhlejší kapitolu, protože často musí rozpracovat organizaci, procesy, finance, podmínky a způsob realizace projektu, podmínky udržitelnosti, součinnosti apod.

Všechny tyto požadavky se přiměřeně aplikují do osnovy dokumentu.

Přiblížení příležitostnému čtenáři

Řada dokumentů je dosti rozsáhlých a tím pro mnoho lidí nečitelných, navíc v situaci, kdy mají i jiné, pro ně prioritnější záležitosti, lidé tyto rozsáhlejší dokumenty vůbec nečtou.

Z tohoto důvodu rozhodně doporučuji u každého dokumentu něco na způsob manažerského shrnutí, ve kterém je uveden stručný výtah z textu a zdůrazněny důležité poznatky a závěry. Alternativně se může označit jako "abstract", "souhrn", "resume", je třeba volit dle typu čtenářů a uvažovaného rozsahu takového shrnutí.

Jako další instrument pro přiblížení čtenáři používám něco, co označuji jako "červená nit". Což znamená, že jednotlivé části na sebe logicky navazují, případně naplňují obsah, který byl definován v úvodu nadřazené kapitoly. Na červenou nit lze koukat jako na příběh, který se rozvíjí s postupem čtení textu.... :-)

Objektivita a ověřitelnost

Pokud se má jednat o kvalitní výstup, je třeba rozlišovat, co jsou fakta a co myšlenky, nápady a domněnky.

Maximum informací v dokumentu musí být ověřitelných, tj. odkazem na zdroj, uvedeno, od koho, kde a za jakých podmínek bylo získáno. K tomu je dobré využívat sekci Zdroje a citace, případně do textu přímo tyto skutečnosti uvést. Obecně platí, že domněnky je třeba ověřovat!

Myšlenky a nápady je třeba takto označit, případně objektivizovat statistickými metodami (průzkumy). Rozhodnutí lze taktéž alespoň z části objektivizovat, např. různé metody matematické podpory rozhodování.

Formální náležitosti

Je třeba, aby si autor zvolil formu, jakou chce dokument prezentovat. Dokument může být velmi formální, stejně tak naprosto neformální, podle způsobu, jakým autor chce prezentovat sebe nebo svůj text.

Osobně nejsem zastáncem absurdně formálních dokumentů, nicméně v praxi využívám přiměřené minimum a to:

• Úvodní strana - obsahuje název dokumentu, klienta, autory, účel, datum poslední aktualizace, verze dokumentu, loga apod. Rozhodně je dobré, když je úvodní strana zajímavá a odlišuje se od jiných dokumentů.
• Styly, písma, barevné schéma, šablona - je nanejvýš vhodné mít zvolené styly, písma a celkovou kulturu textu a zakotveno do šablony, kterou používáme a text se jí přizpůsobuje.
• Přílohy - příliš dlouhé pasáže textu je vhodné vyčlenit do samostatných příloh a do dokumentu uvádět jen důležité věci s odkazy na přílohy.
• Zkratky a pojmy - jiné chápání terminologie je častým problémem a nedorozuměním a proto je vhodné pojmy a zkratky definovat jak v textu, tak uvádět souhrnně v dokumentu.
• Zdroje a citace - je třeba respektovat autorská práva jiných lidí a pokud jejich text chcete využít, je slušné to uvést
• Gramatika, překlepy - pozor na ně, je to Vaše největší vizitka

Uvedené prvky je třeba aplikovat přiměřeně dle charakteru dokumentu.

Nástroje

V současné době máme k dispozici počítače, které nám usnadňují práci a nevyužíváme ani z 10%, to co pomocí nich můžeme udělat a tím si usnadnit práci. Toto je samostatné téma, které využiji v jiném článku.

Závěr

Z celého textu vyplývá výchozí struktura pro tvorbu dokumentů např. v následujícím tvaru, který je však třeba vždy doplnit / modifikovat o specifické záležitosti dané problematiky, zadání apod.

1. Úvodní strana
2. Obsah
3. Úvod - cíl, účel dokumentu, verze, autoři, klient\příjemce
4. Manažerské shrnutí / abstrakt
5. Výchozí stav / situace (analýza)
   1. Stávající stav problematiky - analýza stávajícího stavu problematiky
   2. Stávající stav okolí - aktivity, které přímo nejsou součástí problematiky, nicméně na ni mají dopad (okolní projekty, legislativa)
   3. Požadavky / cíle - sběr a analýza požadavků, doplnění informací k cílům, kritéria úspěšnosti (podklad pro vyhodnocení) apod.
   4. Shrnutí (závěr) - slouží ke shrnutí nejdůležitějších zjištění (v případě návrhů řešení v ICT rád používám shrnutí v obdobě SWOT analýzy)
6. Návrh řešení (syntéza)
   1. Návrh možných (rámcových) variant řešení - varianty dosažení cílů, splnění požadavků apod. Minimálně existují dvě varianty a to, tzv. "nulová" ~ nedělat nic, 1 ~ jakákoliv akce (podle počtu možných akcí se vznikají další varianty)
   2. Výběr nejvhodnější varianty - způsob hodnocení a výběru varianty je téma na samostatný článek...
   3. Zpracování (detailního) návrhu řešení - rozpracování vybrané varianty do návrhu řešení, posouzení možnosti využití lepších hodnocení jiných variant v dílčích kritériích apod. Obecně se jedná o nejrozsáhlejší kapitolu, protože často musí rozpracovat organizaci, procesy, finance, podmínky a způsob realizace projektu, podmínky udržitelnosti, součinnosti apod.
7. Závěr - stručné shrnutí tématu dokumentu a zdůraznění důležitých aspektů
8. Přílohy
9. Zkratky a pojmy - všechny zkratky a pojmy v dokumentu, které vyžadují definici nebo vysvětlení
10. Zdroje a citace