Zdroje technického psaní

Tato stránka shrnuje další zdroje technického psaní.

Průvodce redakčním stylem

Průvodce redakčním stylem definuje zásady komunikace redakční skupiny. Které z následujících pravidel by například měla vašeorganizace přijmout pro nadpisy?

• Nadpisy psát ve větách (psát s velkým písmenem pouze první slovo každého nadpisu)
• Nadpisy psát v titulcích (psát s velkým písmenem většinu slov v každém nadpisu)

Neztrácejte čas a energii dohadováním se o takovýchto otázkách.Místo toho prostě požádejte svou organizaci, aby přijala určitou příručku redakčního stylu. příručka redakčního stylu poskytuje soubor odpovědí na otázky týkající se volby způsobu psaní. Nezáleží na tom, že jedna příručka redakčního stylu obhajuje psaní ve větách a jiná dává přednost psaní v titulcích. Záleží pouze na tom, aby vaše organizace přijala jedinou příručku redakčního stylu.

Aha, ale jakou příručku redakčního stylu? možná již znáte příručky redakčního stylu pro obecné účely (například Chicago Manual ofStyle nebo University of Oxford StyleGuide).Váš technický tým by však měl používat příručku redakčního stylu specializovanou na technické psaní. Doporučujeme zvolit jednu z následujících příruček:

• Průvodce stylem dokumentace pro vývojáře společnosti Google poskytuje redakční pokyny pro každého, kdo píše dokumentaci pro vývojáře pro projekty související se společností Google.
• Průvodce stylem psaní společnosti Microsoft poskytuje pokyny pro každého, kdo píše technickou dokumentaci.

Nepište si vlastní příručku redakčního stylu. Vytvoření a udržování „domácí“ příručky redakčního stylu vyžaduje obrovské zdroje a způsobuje obrovskékonflikty. Přesto některé organizace vymýšlejí novou terminologii, která se v existující příručce redakčního stylu nevyskytuje. Pokud se tak stane, může organizace udělat jednu z následujících věcí:

• Požádat správce redakční stylistické příručky o přidání nových termínů.
• Vytvořit a udržovat vlastní příručku použití nebo stylistickou příručku, která kodifikuje pravopis a použití slov pro odbornou slovní zásobu vaší organizace.

Možnosti otevřené dokumentace

.