pisanie instrukcji krok po kroku

  • 19.01.2018
  • 2 minuty na przeczytanie
    • p
    • m
    • m
    • c
    • v
    • +1

follow te wytyczne ułatwiają tworzenie jasnych, łatwych do naśladowania instrukcji,niezależnie od tego, czy piszesz proste, jednoetapowe procedury, czy złożone procedury, które składają się z wielu kroki.

Zobacz także
formatowanie tekstu w instrukcji
formatowanie interpunkcji

złożone procedury

złożone instrukcje często składają się z wielu kroków sformatowanych jako lista numerowana. W przypadku procedur wieloetapowych na numerowanych listach:

  • konsekwentnie Formatuj procedury, aby klienci mogli je łatwo znaleźć poprzez skanowanie.

  • rozważ użycie nagłówka, aby pomóc klientom szybko znaleźć instrukcje. Użyj nagłówka, aby powiedzieć klientom, co instrukcje pomogą im zrobić.
    przykłady
    Aby dodać konto
    Dodaj konto

    wybierz jeden styl frazowania nagłówków i napisz je wszystkie w ten sam sposób (w równoległej strukturze).

  • użyj osobnego numerowanego wpisu dla każdego kroku. Można łączyć krótkie kroki, które występują w tym samym miejscu w interfejsie użytkownika.

  • w większości przypadków zawiera akcje, które finalizują krok, takie jak przyciski OK lub Zastosuj.

  • używaj pełnych zdań.

  • użyj form czasownika imperatywnego. W instrukcji klienci naprawdę chcą, abyś powiedział im, co mają robić.

  • użyj spójnych struktur zdań. Na przykład Zawsze używaj frazy, gdy musisz powiedzieć klientowi, od czego zacząć. Przez resztę czasu każde zdanie zaczynaj od czasownika.
    przykłady
    na wstążce przejdź do zakładki projekt.
    Otwórz zdjęcia.
    Aby wyrównać, wybierz lewo.

  • pierwsze słowo w każdym kroku.

  • użyj okresu po każdym kroku.
    wyjątek
    podczas instruowania klientów, aby wpisywali dane wejściowe, które nie zawierają znaków interpunkcyjnych, nie używaj kropki. Spróbuj sformatować tekst tak, że wejście użytkownika pojawia się w nowej linii.

  • Ogranicz procedurę do siedmiu kroków, a najlepiej mniej. Spróbuj zmieścić wszystkie kroki na tym samym ekranie.
    przykłady

    aby utworzyć grupę kafelków

    1. na ekranie startowym, wybierz kafelki, które chcesz zgrupować.
    2. przeciągnij je na otwartą przestrzeń. Gdy za nimi pojawi się szary pasek, zwolnij kafelki, aby utworzyć nową grupę.

    aby zaplanować sprinty

    1. w widoku zaległości wybierz pierwszy sprint w obszarze bieżąca. Możesz też otworzyć swój backlog sprintów z następującego adresu URL:https://AccountName/DefaultCollection/TeamProjectName/_backlogs/iteration
      kilka predefiniowanych sprintów znajduje się na liście bieżącej i przyszłej. Rzeczywiste tytuły sprintu różnią się w zależności od szablonu procesu użytego do utworzenia projektu zespołowego. Jednak daty kalendarzowe nie zostały przypisane.
    2. aby ustawić daty kalendarza, wybierz pierwszy sprint w obszarze bieżący i wybierz daty.

procedury jednoetapowe

Jeśli używasz spójnego formatu instrukcji krok po kroku,użyj tego samego formatu instrukcji jednoetapowych, ale zamień number na punktor.
przykład
Aby przenieść grupę kafelków

  • na ekranie startowym, Pomniejsz i przeciągnij grupę tam, gdzie chcesz.

Wskazówki dotyczące pisania kroków

upewnij się, że klient wie, gdzie akcja powinna się odbyć, zanim ją opisz.

  • jeśli instrukcja pojawia się w tym samym interfejsie użytkownika, w którym ma miejsce akcja, zwykle nie jest konieczne podawanie szczegółów lokalizacji.

  • Jeśli chcesz upewnić się, że klient zaczyna we właściwym miejscu, podaj krótką frazę na początku kroku.
    przykład
    na karcie Projekt wybierz wiersz nagłówka.

  • Jeśli istnieje szansa na zamieszanie, podaj krok wprowadzający.
    przykład
    na wstążce przejdź do zakładki projekt.

proste instrukcje ze wspornikami kątowymi

skracają proste sekwencje za pomocą nawiasów kątowych. Dodawaj spacje przed i po każdym nawiasie i nie pogrubiaj ramek.

przykład
Wybierz konta> inne konta> Dodaj konto.

wskazówka dostępności czytniki ekranu mogą pominąć nawiasy i odczytać instrukcje, takie jak Menu> przejdź do> foldery jako menu Przejdź do folderów, co może dezorientować klientów. Przed zastosowaniem tego podejścia należy skontaktować się z ekspertem ds. dostępności.

Dodaj komentarz

Twój adres e-mail nie zostanie opublikowany.