Toolverse
Wszystkie skille

prowler-docs

autor: prowler-cloud

Przewodnik stylistyczny do pisania dokumentacji Prowlera – spójność, jasność, dostępność

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

O skillu

Skill do pisania dokumentacji Prowlera zgodnie z wytycznymi marki. Zawiera standardy formatowania, zasady komunikacji bezstronnej, wytyczne SEO i konwencje terminologiczne. Aktywuje się automatycznie podczas tworzenia dokumentacji funkcji, tutoriali, przewodników i notek wydania. Pomaga utrzymać spójny ton, unikać jargonu, stosować Title Case w nagłówkach i umieszczać słowa kluczowe na początku zdań.

Jak używać

  1. Aktywuj skill podczas pracy nad dokumentacją Prowlera – automatycznie włączy się, gdy zaczniesz pisać dokumentację funkcji, przewodniki, tutoriale lub notatki wydania. 2. Stosuj wytyczne Brand Voice: unikaj zaimków rodzajowych (używaj "ty/twoje" lub "oni/one"), wybieraj słowa inkluzywne, definiuj terminy techniczne i akronimy przy pierwszym użyciu (np. "Identity and Access Management (IAM)"). 3. Formatuj nagłówki Title Case (każde słowo z dużej litery), stosuj łączniki w pozycji prenominalnej (np. "world-leading company") i używaj list punktowanych do logicznie podzielonych informacji. 4. Optymalizuj pod SEO, umieszczając słowa kluczowe na początku zdań i nagłówków – zamiast "Otwórz terminal, aby utworzyć rolę" napisz "Aby utworzyć rolę, otwórz terminal". 5. Preferuj konstrukcje czasownikowe zamiast nominalnych ("raport został utworzony" zamiast "utworzenie raportu") i używaj przystępnego języka, minimalizując żargon. 6. Sprawdzaj formatowanie interakcji: dla pulpitu używaj "Kliknij", "Kliknij dwukrotnie", "Kliknij prawym przyciskiem", "Przeciągnij", "Przewiń"; dla urządzeń dotykowych – "Dotknij", "Dotknij dwukrotnie", "Przytrzymaj", "Przesuń", "Szczypnij".

Podobne skille