Documentation/Style guide/cs

Přehled
Tento průvodce stylem poskytuje návod pro psaní a úpravy technické dokumentace v MediaWiki a dalších technických oblastech. Poskytuje tipy, které vám pomohou napsat jasnou a stručnou technickou dokumentaci v jednoduchém jazyce. Odkazuje také na další zdroje o technickém psaní a úpravách obecně.

Dobrá technická dokumentace usnadňuje lidem přispívat do projektů Wikimedie. Je důležité dodržovat jasné standardy a stylové pokyny pro psaní a úpravy dokumentace, zvláště když přispěvatelé a čtenáři mají různé úrovně dovedností a zkušeností. Ať už se považujete za spisovatele nebo ne, vaše příspěvky jsou potřebné a ceněné!



Anglický Wikipedia Manual of Style
English Wikipedia's Manual of style podrobně pokrývá obecná témata psaní (jako je interpunkce) a shrnuje klíčové body jiných stylových příruček. Může to být užitečná reference pro každého, kdo píše nebo upravuje technickou dokumentaci v angličtině napříč projekty Wikimedie, zvláště pokud místní wiki nemá konkrétnější pokyny.

Tato stránka obsahuje základní pokyny a tipy, které vám pomohou začít s technickou dokumentací. Obsahuje některé informace specifické pro technickou dokumentaci, která není zahrnuta ve Wikipedii Manual of Style.



Publikum a obsah


Psaní pro technické publikum
Než začnete psát, zvažte publikum vaší práce:


 * Kdo bude číst tuto technickou dokumentaci?
 * Odkud pochází?
 * Jak dobře jsou obeznámeni s pojmy, které prezentujete?
 * Co mohou potřebovat vědět, aby porozuměli?

Jakmile porozumíte svému publiku, budete mít lepší smysl pro to, co potřebujete ke komunikaci.



Psaní s určitým účelem
K čemu bude sloužit vaše technická dokumentace? Existuje mnoho důvodů, proč psát dokumentaci. Je užitečné vědět, proč píšete a jaký je váš cíl, než začnete.


 * Je to naučit někoho, jako nováčka, o procesu nebo konceptu?
 * Je to ukázat někomu, jak sledovat proces?
 * Má to poskytnout pozadí a kontext pro koncept nebo proces?
 * Je to odkaz určený k poskytování informací?



Psaní v kontextu
Když se rozhodujete, co napsat a jak to čtenáři zarámovat, může vám pomoci definovat kontext nebo příležitost pro vaše psaní. Vaše komunikace probíhá v kontextu větší situace. Kontext může být ohraničen dobou, ve které píšete, typem dostupné technologie, vaší geografickou polohou a kulturou nebo současnou kulturou a komunikačním stylem vašich čtenářů. Tato příležitost může být osobní a může vycházet ze situace, která vás motivovala k vytvoření nebo vylepšení části dokumentace.

Pokud například píšete technickou dokumentaci pro projekty Wikimedie, zvažte kulturu vytvořenou jednotlivci, kteří se těchto projektů účastní. Jak byste mohli nejlépe umístit své psaní do kontextu této komunity a její kultury, abyste vytvořili co nejsmysluplnější a nejužitečnější technickou dokumentaci?



Uživatelské testování a zpětná vazba
Vytvářejte technickou dokumentaci ke sdělení nápadů a konceptů skutečnému uživatelskému publiku. Přirozeně by toto publikum mělo hrát klíčovou roli v tom, jak je dokumentace utvářena a přetvářena. Přemýšlejte o tom, jak můžete získat informace o zkušenostech vašich uživatelů. Udělejte si čas na zodpovězení následujících otázek:


 * Obsahuje vaše dokumentace mechanismus pro zpětnou vazbu?
 * Dokážete se včas zapojit do rozhovorů s publikem, abyste dosáhli zlepšení?
 * Můžete použít fóra jako Stack Overflow nebo mailing listy ke kontrole, zda váš dokument odpovídá na nejčastější otázky, které lidé mají ohledně vašeho konkrétního tématu?



Jasnost a konzistence
Přehlednost a konzistence usnadňuje přístup, čtení a vytváření technické dokumentace napříč projekty MediaWiki/Wikimedia. Technická dokumentace je napsána pro široké publikum a upravována řadou přispěvatelů.

Hlas, tón, použití gramatiky, styl a formát by měly být konzistentní napříč technickou dokumentací a podobnými kolekcemi obsahu. To pomáhá čtenářům naučit se orientovat v informacích a přispěvatelům usnadňuje pochopení, jak upravovat a přidávat nové informace.



Rozhodování o typu dokumentu
Nejprve určete své hlavní publikum, účel a kontext, abyste se rozhodli, jaký typ dokumentu vytvoříte.

Jazyk
Tato část stručně zmiňuje některá témata, která stojí za to prozkoumat jinde podrobněji. Vždy zkontrolujte svá slova a výrazy podle těchto kritérií na Wikt: Wikislovníky pokrývají stovky jazyků, explicitně uvádějí gramatické a lexikální rysy slov a jejich skloňování, poskytují podrobné kontextové popisky (včetně žargonu, britské vs. americké angličtiny) a odhalují, jak jsou přeložitelné termíny ve stovkách dalších jazyků.



Obyčejná angličtina
Pamatujte prosím: Mnoho návštěvníků těchto stránek není rodilými mluvčími angličtiny.

Pro dokumentaci psanou v angličtině nejlépe funguje Plain English (také nazývaná plain language). Prosté písmo je nejsrozumitelnější pro různé publikum a také se nejsnáze překládá. Existuje řada dobrých nástrojů pro kontrolu vašeho psaní v pokynech pro psaní Tech News na Meta-Wiki.



Hlas a tón
MediaWiki je místo, kde může kdokoli upravovat. Proto může být obtížné udržet konzistentní hlas a tón v dokumentaci.

Zvažte použití těchto prvků při psaní:



Úhel pohledu

 * Když oslovujete své publikum, použijte druhou osobu ("vy" nebo předpokládané "vy").
 * Vyhněte se first person ("já" nebo "my"), pokud nepíšete FAQ s otázkami položenými z pohledu první osoby.
 * Pro většinu dokumentace zaměřené na cíle nebo proces použijte imperativní náladu.

Datumy

 * Vždy používejte celý čtyřmístný rok.
 * Použijte absolutní data ("v květnu 2037") namísto relativních dat ("příští rok v květnu").
 * Vyhněte se přidávání dat, která budou vyžadovat pravidelné ruční aktualizace. Příklad: Když odkazujete na aktuální rok, napište  místo, bez ohledu na to, jaký je právě rok.



Přehled
Všechny stránky by měly obsahovat sekci s přehledem (také nazývanou Lead section), která vysvětluje:


 * 1) Účel stránky
 * 2) Publikum stránky
 * 3) Předpoklady, které musí čtenář znát, než bude pokračovat (např. pracovní znalost Pythonu)
 * 4) Software nebo nástroje, které bude čtenář potřebovat k dokončení procesů nebo úkolů uvedených na stránce (např. nainstalovaná Java)
 * 5) Případ použití, případová studie, praktické pochopení produktu, služby nebo nástroje v akci. (volitelný)



Obsah

 * Každá stránka by měla obsahovat obsah, aby byly informace snadno přístupné.



Titulky a nadpisy

 * Použijte zásady pro nadpisy.
 * Udržujte písma nadpisů konzistentní v celé dokumentaci.
 * Volitelné použití kotvy k propojení sekcí nebo podsekcí na stejné stránce.
 * Za nadpisy oddílů přidejte prázdný řádek. To má vliv na jak je obsah zabalen pro překlad.
 * Neumisťujte nadpis před svůj přehled nebo hlavní sekci.



Informační tok
Stránky technické dokumentace by měly mít konzistentní vzor napříč kolekcemi obsahu.

Ideální vzor pro každou stránku může být:


 * Název stránky
 * Úvod/Přehled
 * Nadpis
 * Obsah
 * V případě potřeby podnadpis
 * Obsah



Formátování textu
<span id="Formatting_code_examples_and_other_technical_elements">

Příklady formátování kódu a další technické prvky
Formátování odlišuje kód a další technické prvky od běžného textu.

Šablony
Šablony se často používají na stránkách MediaWiki.org. Šablony mohou pomoci udržet konzistenci a mohou usnadnit překlad informací.

Níže jsou uvedeny některé běžné šablony.

<span id="Templates_for_page_formatting">

Šablony pro formátování stránky

 * caution, fixtext, note, tip, todo, warning - pro styly vkládaných zvýrazněných polí
 * fixme, historical, notice, outdated, update - pro schránky zpráv na stránce/sekci
 * main, see also - pro poznámky ke stránce/sekci (krátká poznámka umístěná v horní části článku)

<span id="Templates_for_MediaWiki_core_and_Git_source">

Šablony pro jádro MediaWiki a zdroj Git

 * class doclink, file doclink, js doclink - odkaz na vygenerovanou dokumentaci jádra MediaWiki
 * MW file - pro krabici s informacemi a odkazy na soubor v jádru MediaWiki
 * git file - pro odkaz na zdrojový kód

<span id="Templates_for_Phabricator">

Šablony pro Phabricator

 * ptag - pro značku projektu Phabricator v pravém horním rohu stránky
 * tracked - pro související úlohu Phabricator

<span id="Other_useful_templates">

Další užitečné šablony

 * - pro IRC odkaz
 * Key press - pro např. Ctrl a button na, např.
 * ApiEx - pro adresy URL požadavku api.php
 * Api help - převést vygenerovanou dokumentaci API
 * RestOfVariableName - pro globální proměnné
 * tag - pro rychlý způsob, jak zmínit značku ve stylu XML předformátovaným způsobem

Překlady
Všechny stránky na mediawiki.org jsou kandidáty na překlad do více jazyků. MediaWiki.org je vícejazyčná wiki, používá rozšíření Translate k prezentaci alternativních překladů a správě překladu stránek.

<span id="See_also">

Související odkazy

 * Některé další průvodce stylem technické dokumentace:
 * Průvodce stylem dokumentace pro vývojáře Google
 * Průvodce stylem psaní MDN Web Docs
 * Technical writing
 * Další jazykové zdroje:
 * seznam slov
 * Naming things
 * Naming things