Stylistické příručky

Kód jazyka: en-US

Případ použití: SaaS B2B produkt – Centrum nápovědy a uživatelské rozhraní

# Stylistická příručka: EN-US – Články Centra nápovědy

## 1. Účel a rozsah

Tato stylistická příručka definuje standardy psaní pro veškerou **dokumentaci Centra nápovědy** v **angličtině (Spojené státy)**.

Platí pro:

- Články s návody  
- Vysvětlení funkcí  
- Příručky pro řešení problémů  
- Záznamy FAQ  

**Cílová skupina:** profesionální uživatelé SaaS v technických a obchodních rolích  
**Cíl:** pomoci uživatelům rychle, sebevědomě a bez zmatku dokončit úkoly.

---

## 2. Hlas a tón

Obsah Centra nápovědy by měl znít:

- **Jasně a profesionálně**
- **Podporující a zaměřený na řešení**
- **Sebevědomě, ne propagačně**

Píšeme jako průvodce, který pomáhá uživatelům uspět — ne jako marketingový text.

### Principy tónu

| Do | Don’t |
|---|------|
| Buďte klidní a přímí | Buďte příliš neformální nebo povídaví |
| Zaměřte se na další kroky | Zaměřte se pouze na to, co se pokazilo |
| Použijte neutrální jazyk | Použijte sarkasmus nebo humor |

**Příklady**

- ✅ „Pokud dojde k chybě připojení, zkontrolujte svůj API token a zkuste to znovu.“  
- ❌ „Váš token je špatný. Opravit to.“ 

---

## 3. Gramatika a styl psaní

### 3.1 Oslovte čtenáře přímo

Použijte **vy** pro jasné pokyny.

- ✅ „Můžete spravovat uživatele z administrační stránky.“  
- ❌ „Uživatelé mohou být spravováni z administrační stránky.“

---

### 3.2 Preferujte aktivní hlas

Aktivní hlas je kratší a snáze sledovatelný.

- ✅ „Vyberte **Uložit změny**.“  
- ❌ „Změny by měly být uloženy.“

---

### 3.3 Udržujte věty stručné

- Snažte se o **25 slov nebo méně**
- Jedna hlavní myšlenka na větu
- Rozdělte dlouhá vysvětlení na kroky nebo odrážky

---

### 3.4 Použijte jednoduchý jazyk

Vyhněte se zbytečné složitosti.

- ✅ „Zahajte nový projekt.“  
- ❌ „Iniciujte vytvoření nového projektu.“

---

## 4. Terminologie a konzistence

### 4.1 Použijte schválené termíny

Používejte názvy produktů a funkcí přesně tak, jak jsou definovány.

- Udržujte konzistentní velká písmena  
- Nevymýšlejte synonyma pro klíčové pojmy  

**Příklad**

- ✅ „pracovní prostor“  
- ❌ „prostor,“ „projektová oblast,“ „prostředí“

---

### 4.2 Definujte neobvyklé zkratky

Běžné termíny (API, URL) není třeba definovat.  
Interní nebo neobvyklé zkratky by měly být vysvětleny při prvním použití.

- ✅ „Systém jednotného přihlašování (SSO)“  
- ❌ „SSO“ bez kontextu

---

### 4.3 Konvence americké angličtiny

Vždy používejte **americké pravopisné normy**.

- ✅ „přizpůsobit,“ „chování“  
- ❌ „přizpůsobit“, „chování“

---

## 5. Standardy formátování a Markdown

### 5.1 Nadpisy

Použijte jasné, úkolově orientované nadpisy.

- ✅ „Obnovte své heslo“  
- ❌ „Přehled procesu obnovy hesla“

Hierarchie nadpisů:

- `#` Název článku  
- `##` Hlavní sekce  
- `###` Podsekce pouze když je to nutné  

---

### 5.2 Seznamy

Použijte číslované seznamy pro sekvence:

1. Otevřete **Nastavení**  
2. Vyberte **Fakturaci**  
3. Zvolte **Změnit plán**  

Použijte odrážky pro možnosti:

- Správci mohou spravovat uživatele  
- Editoři mohou aktualizovat obsah  

---

### 5.3 UI prvky

Formátujte UI štítky konzistentně:

- Tlačítka: **tučné**
- Navigační cesty: použijte šipky

Příklad:

Přejděte na **Nastavení → Fakturace → Změnit edici**.

---

### 5.4 Odkazy

Odkazy musí popisovat cíl.

- ✅ „Zobrazit průvodce fakturací“  
- ❌ „Klikněte zde“

---

## 6. Standardní struktura článku

Každý článek v Centru nápovědy by měl dodržovat tuto strukturu:

### 1. Shrnutí

Začněte 1–2 větami vysvětlujícími výsledek.

> Tento článek vysvětluje, jak změnit své předplatné.

---

### 2. Požadavky (volitelné)

Seznamte požadavky předem.

- Oprávnění správce  
- Aktivní předplatné  

---

### 3. Pokyny krok za krokem

Kroky by měly být:

- Orientované na akci  
- Jedna akce na krok  
- Napsané jako příkazy  

Příklad:

1. Přejděte do **Nastavení**.  
2. Vyberte **Fakturaci**.  
3. Zvolte **Změnit edici**.  

---

### 4. Očekávaný výsledek

Řekněte uživateli, co by se mělo stát.

> Váš nový plán nabývá účinnosti okamžitě po potvrzení.

---

### 5. Další kroky (volitelné)

Poskytněte související akce nebo odkazy.

- Spravovat faktury  
- Aktualizovat platební metodu  

---

## 7. Odstraňování problémů a chyby

### 7.1 Buďte uklidňující

- ✅ „Nemohli jsme se připojit. Zkuste to prosím znovu.“  
- ❌ „Připojení selhalo. Kritická chyba.”

---

### 7.2 Zaměřte se na řešení

Vždy zahrňte, co by uživatel měl udělat dál.

- Zkontrolujte přihlašovací údaje  
- Potvrďte oprávnění  
- Kontaktujte podporu, pokud je to potřeba  

---

### 7.3 Nikdy neobviňujte uživatele

Vyhněte se jazyku jako:

- „Udělali jste něco špatně“  
- „Neplatný vstup“ (bez vysvětlení)

Preferované:

> „Token může být neplatný. Vygenerujte nový a zkuste to znovu.”

---

## 8. Shrnutí Dělat / Nedělat

### Dělat

- Pište obsah zaměřený na úkol, založený na fázích  
- Použijte konzistentní terminologii  
- Udržujte věty krátké a přímé  
- Použijte popisné nadpisy a odkazy  
- Udržujte klidný a podpůrný tón  

### Nedělejte to

- Přidávejte marketingový jazyk  
- Používejte idiomy nebo slang  
- Míchejte termíny pro stejný koncept  
- Obviňujte uživatele při řešení problémů  
- Pište dlouhé odstavce bez struktury  

---

## Příklad (Preferováno)

Chcete-li změnit svůj plán:

1. Přejděte na **Nastavení → Fakturace**  
2. Vyberte **Změnit plán**  
3. Vyberte možnost a klikněte na **Potvrdit**