Rychlý start se stylem a hlasem v Microsoft Learn

Tento rychlý start je stručný průvodce psaním technického obsahu pro publikaci v Microsoft Learn. Tyto pokyny platí, ať už vytváříte novou dokumentaci, nebo upravujete tu existující.

Osvědčené postupy:

• Zkontrolujte pravopis a gramatiku v článcích, i kdybyste je kvůli tomu museli zkopírovat a vložit do Microsoft Wordu.
• Používejte přirozený a přívětivý způsob vyjadřování, jako byste se s někým jiným osobně bavili.
• Používejte jednoduché věty. Díky snadno čitelným větám může čtenář rychle postupovat podle vašich pokynů.

Použití zásad způsobu vyjadřování Microsoftu

Snažíme se dodržovat tyto principy při psaní technického obsahu pro Microsoft Learn. Ne vždy se nám to podaří, ale musíme se o to pořád snažit.

• Soustřeďte se na účel: Zákazníci se na naši dokumentaci obrací s určitým záměrem. Než začnete psát, jasně si stanovte, kdo je zákazníkem a čeho se snaží docílit. Potom napište svůj článek, abyste tomuto konkrétnímu zákazníkovi s jeho konkrétním úkolem pomohli.
• Používejte běžná slova: Zkuste používat přirozený jazyk a slova, která vaši zákazníci sami používají. Buďte méně formální, ale ne na úkor odbornosti. Uvádějte příklady, které vysvětlují nové koncepty.
• Pište stručně a výstižně: Neplýtvejte slovy. Buďte pozitivní a nepoužívejte nadbytečná slova nebo přemíru přívlastků. Pište krátké a výstižné věty. Držte se tématu. Pokud má úkol kvalifikátor, umístěte ho na začátek věty nebo odstavce. Snažte se také používat co nejméně poznámek. Pokud vám snímek obrazovky ušetří nějaká slova, použijte ho.
• Tvořte články, které lze rychle pročíst: Nejdůležitější informace umístěte na začátek. Pomocí sekcí rozdělte dlouhé postupy na snadněji zpracovatelné skupiny kroků. (Postupy s více než 12 kroky jsou pravděpodobně příliš dlouhé.) Snímek obrazovky můžete použít, když přidá přehlednost.
• Projevte soucit: Používejte v článku podporující tón a snažte se vyvarovat právních omezení. Upřímně upozorňujte na oblasti, které budou pro zákazníky frustrující. Přesvědčte se, že se článek soustředí na to, na čem záleží zákazníkovi, aby se nejednalo jen o technickou přednášku.

Ohleduplnost vůči lokalizaci a strojovému překladu

Naše technické články se překládají do několika jazyků a některé z nich se upravují pro konkrétní trh nebo zeměpisnou oblast. Uživatelé také můžou na webu ke čtení technických článků používat strojový překlad. Myslete proto při psaní článků na tyto pokyny:

• Přesvědčte se, že článek neobsahuje žádné gramatické, pravopisné ani interpunkční chyby: Mělo by se dodržovat obecně. Některé editory Markdownu (jako Markdown Pad 2.0) mají základní kontrolu pravopisu, ale doporučuje se zobrazený HTML obsah článku vložit do Wordu, který má kvalitnější kontrolu pravopisu a gramatiky.
• Pište co nejkratší věty: Dlouhá a složitá souvětí překlad znesnadňují. Věty rozdělte, jen pokud to není nadbytečné nebo to nezní divně. Nechceme ani, aby byly články psané nepřirozeně.
• Používejte jednoduchou a jednotnou stavbu vět: Jednotnost je pro překlad lepší. Vyhýbejte se závorkám a vsuvkám a důležité informace umísťujte na konec věty. Prohlédněte si několik publikovaných článků. Pokud má článek přívětivý styl, který se dobře čte, použijte ho jako model.
• Buďte jednotní ve svých formulacích a velkých písmenech: Jednotnost je opět nejdůležitější. Nepište u slov velká písmena, pokud se nejedná o začátek věty nebo vlastní jméno.
• Nevynechávejte „kohezivní prostředky“: Slova, která pro nás mohou být nedůležitá, protože vyplývají z kontextu (například spojky), jsou pro strojový překlad velmi důležitá. Nezapomeňte je správně používat.

Další problémy se stylem a způsobem vyjadřování, na které si dát pozor

• Nepřerušujte postup komentářem nebo vsuvkami.
• U postupu, který obsahuje fragmenty kódu, přidejte další informace o daném kroku ke kódu jako komentář. Snižuje se tím množství textu, který musí uživatelé přečíst. Klíčová informace se zkopíruje do projektu s kódem, aby uživatelům připomněla, k čemu kód slouží, až si ji později přečtou.
• Používejte velká písmena na začátku názvů a nadpisů.
• Rozlišujte „odebrat“ a „odstranit“.
• Další pokyny najdete v průvodci správným stylem při psaní pro Microsoft.

Lokalizovaná dokumentace

• Pokud přispíváte do lokalizované dokumentace, projděte si odkazy na globalizaci.
• Pokud chcete získat pokyny pro lokalizaci, informace o stylu jazyka a jeho použití v technických publikacích a informace o formátech dat pro konkrétní trh, stáhněte si ve svém jazyce průvodce správným stylem.
• Navštivte terminologii Microsoftu a vyhledejte schválenou terminologii pro konkrétní produkt nebo si stáhněte kolekci terminologie Společnosti Microsoft ve vašem jazyce.
• Další informace o lokalizaci najdete v části věnované globální komunikaci v průvodci správným stylem při psaní pro Microsoft.

Poznámka:

Většina lokalizovaných dokumentace nenabízí možnost upravovat ani poskytovat zpětnou vazbu prostřednictvím GitHubu. Pokud chcete poskytnout zpětnou vazbu k lokalizovaného obsahu, použijte https://aka.ms/provide-feedback formulář.