Jak napisać instrukcję

Autor: Monica Porter
Data Utworzenia: 19 Marsz 2021
Data Aktualizacji: 1 Lipiec 2024
Anonim
Jak napisać instrukcję dla robota i go zaprogramować?
Wideo: Jak napisać instrukcję dla robota i go zaprogramować?

Zawartość

Pisanie instrukcji to trudne zadanie, ale w rzeczywistości jest to łatwiejsze niż myślisz! Poniższe kroki odnoszą się do każdego samouczka, od prostych samouczków (jak oklaskiwać) po bardziej złożone tematy (jak zrobić półprzewodniki).

Kroki

Część 1 z 4: Zrozumienie tematu

  1. O to chodzi. To może być oczywiste, ale wiedza jest kluczem do napisania dobrego przewodnika. Na przykład, jeśli piszesz o tym, jak korzystać z aparatu, musisz wiedzieć, że przysłona i czas otwarcia migawki to nie tylko dwie oddzielne funkcje - w istocie - ale jeśli rozumiesz te dwie jako współdziałające. Wspólnie będziecie mogli łatwo opisać każdą funkcję w odniesieniu do całości.

  2. Porozmawiaj z ekspertem. Jeśli Twoja rola jest po prostu pisarzem, a nie ekspertem w interesującym Cię temacie, skontaktuj się z osobami, które posiadają odpowiednią wiedzę w procesie pisania i upewnij się, że Twoje instrukcje zostaną przez nich ponownie przeczytane. Wsparcie. Ich wiedza i rady są nieocenione.

  3. Spróbuj tego doświadczyć na własnej skórze. Jeśli to możliwe, spróbuj doświadczyć tego, o czym piszesz, co jest szczególnie pomocne, ponieważ jako użytkownik masz szansę poczuć rzeczy, aby wiedzieć, czego chcą się dowiedzieć.
  4. Przeczytaj więcej na ten temat. Dowiedz się, jak zaprezentować swój produkt i być orędownikiem produktu, o którym piszesz.
    • Podręczniki użytkownika dla podobnych produktów zawierają odniesienia do innych autorów dotyczące sposobu radzenia sobie z tym tematem.
      • Znajdź podobieństwa między autorami, jak opisują podobne funkcje i podejścia.
      • Znajdź wyjątkowe różnice. Różnice te mogą być unikalnymi cechami produktu. Twój produkt może mieć te funkcje lub nie, lub możesz znaleźć inne sposoby opisania swojego produktu, aby zwiększyć jego wartość. Chociaż Twoim zadaniem jest pisanie instrukcji, pokazanie klientom wartości ich zakupów jest najskuteczniejszym sposobem na zachęcenie ich do dalszego czytania instrukcji.
    • Uważnie przestudiuj czasopisma branżowe. Dowiedz się, jak osoby korzystające z tego produktu wchodzą z nimi w interakcje każdego dnia. Jeśli chcą, aby produkt dodał jakąś funkcjonalność w celu rozwiązania konkretnego problemu, a jeśli Twój produkt jest rozwiązaniem, oto najważniejsze informacje, które musisz zrobić.
    Reklama

Część 2 z 4: Zarys wytycznych


  1. Podzielony na małe sekcje. Niezależnie od tego, czy jest to prosty przewodnik krok po kroku, czy instrukcja obsługi aparatu cyfrowego 35 mm, podzielenie go na łatwe w obsłudze sekcje ma kilka zalet:
    • Możesz skupić się na każdej części produktu jako całości. Twoim celem jest zapoznanie użytkownika z procesem rozumienia metody. Sposób korzystania z każdej funkcji można znaleźć w ostatniej sekcji, jeśli jest to pożądane, lub aby użytkownik sam się z nią zapoznał.
  2. Postępuj zgodnie z logiczną sekwencją. Na przykład nie ma sensu, jeśli opiszesz, jak działa lampa błyskowa aparatu, zanim opiszesz, jak zamontować obiektyw, zamontować filmy, włączyć aparat i ustawić ostrość. Jest to niezwykle skuteczne, jeśli nie dogłębnie rozumiesz temat.
  3. Rozważ konspekt w tym samym czasie, co spis treści.
  4. Przejrzyj kroki. Po zidentyfikowaniu logiki przejrzyj ją, aby upewnić się, że wszystko zostało uwzględnione.
  5. Zbierz zapasy do wykorzystania. Elementy, które opisujesz, powinny być przygotowane i gotowe do natychmiastowego użycia, zgodnie z instrukcją. Jeśli robisz pudełko papierowe, musisz mieć gotowy papier, nożyczki, taśmę, klej i linijkę. Jeśli piszesz o aparacie, upewnij się, że aparat jest rozebrany. Jeśli to możliwe, tworzony przez Ciebie produkt powinien znajdować się w pudełku na tym etapie. Reklama

Część 3 z 4: Pierwsze kroki Pisanie

  1. Napisz wprowadzenie. Wprowadzenie nadaje ton całemu samouczkowi i daje czytelnikom przegląd rodzaju przewodnika, który zamierzają przeczytać. Czy będzie to zabawny, lekki dokument, czy też jasny i wiarygodny. To zależy od Twoich czytelników. Powinieneś używać tekstu do materiałów, które uczą dzieci, jak robić kartony, a nie w poradniku lekarza na temat operacji serca. Określ głos od początku i bądź konsekwentny w całym przewodniku.
  2. Postępuj zgodnie z każdym napisanym krokiem. Na każdym etapie Twoje instrukcje będą nie tylko bardziej uczciwe i niezawodne, ale także sprawią, że nie przegapisz żadnego.
    • Jeśli z jakiegoś powodu trudno ci podjąć kroki, pomyśl dwa razy i poproś kogoś, kto jest ekspertem, o poradę.
  3. Liczba stopni. Numerowane kroki ułatwiają śledzenie i przeglądanie, jeśli zgubią się.
    • Jeśli piszesz na papierze, zostaw trochę odstępu między każdym krokiem. Pamiętaj, aby ponownie numerować, jeśli dodasz jakiekolwiek kroki.
  4. Dodaj porady i ostrzeżenia. W trakcie pisania możesz zdać sobie sprawę, że problemy pojawiają się, jeśli użytkownik nie będzie działał ostrożnie.
    • Wręcz przeciwnie, jeśli masz jakąkolwiek wiedzę, która sprawia, że ​​korzystanie z niej jest łatwiejsze i przyjemniejsze dla użytkowników, dodaj więcej.
  5. Ćwicz ponownie. Używaj tylko zapisanych instrukcji, dokładnie przestrzegając ich. Jeśli znajdziesz brakujące części instrukcji, dodaj niezbędne informacje. Powtarzaj ten krok, dopóki nie wykonasz wszystkich czynności i nie będziesz w stanie śledzić tego, co napisałeś, bez dodawania żadnych notatek.
    • Może najpierw poproś znajomego lub dwóch, aby skorzystali z przewodnika. Uważnie monitoruj, w jaki sposób używają produktu. Zobacz, gdzie szybko spoglądają. Zobacz, na jakim etapie są zdezorientowani, zdezorientowani lub niezdolni do podjęcia. Posłuchaj ich, a następnie dostosuj się do odpowiednich instrukcji.
  6. Przeczytaj ponownie instrukcje. Nie należy wysyłać ostatecznej wersji do redakcji (bez względu na to, czy jest to Twoja agencja, czy współmałżonek) jako wypełniony błędami przewodnik. Reklama

Część 4 z 4: Układ

  1. Zaczynając od góry. Po wykonaniu wszystkich szczegółowych czynności, które musisz wykonać, zapoznaj się z całym przewodnikiem, aby znaleźć odpowiednie nagłówki dla każdej grupy.
    • Nazwij i zanotuj lokalizację.
  2. Jeśli to możliwe, napisz spis treści. Zobacz układ wikiHow jako przykład. Strona główna pokaże tytuły każdej sekcji. Gdy przejdziesz przez każdą sekcję, pojawią się podgrupy, a w podgrupach wyświetlone zostaną nagłówki. Im bardziej szczegółowy jest Twój przewodnik, tym więcej dużych i mniejszych grup będziesz potrzebować. (Pisanie przykładów Jak gwizdać nie jest wymagane, jak wyrzeźbić flet będzie potrzebować kilku, a jak grać na flecie zajmie dużo czasu!)
  3. Ulepszony. Tak, raz to zrobiłeś. Ale za drugim razem nadal będziesz w stanie dostrzec małe błędy lub punkty niejasności.
    • Aby uzyskać bardziej szczegółowy przewodnik, możesz skorzystać z okazji, aby zanotować wszystkie podtematy i wykorzystać te informacje do utworzenia spisu treści.
  4. Wybierz tytuł. Reklama

Rada

  • Nawet jeśli już coś rozumiesz, po prostu zapisz każdy krok. Unikniesz pominięcia nieznanych części użytkownika. Podanie większej ilości informacji jest lepsze niż pomijanie ważnych kroków.
  • Jeśli masz zamiar napisać bardzo szczegółową instrukcję i musisz podzielić ją na rozdziały, np Jak grać na flecie, to pierwszym krokiem, który należy zrobić, jest lista wszystkich rozdziałów, na przykład Wybierz flet, zmontuj i zachowaj, utwórz dźwięk, metodę umieszczania, pierwsze prace itp. Następnie musisz zastosować podstawowe zasady podczas pisania instrukcji do każdego rozdziału, ponieważ każdy rozdział jest jak przewodnik!
  • O ile to możliwe, zilustruj swoje wskazówki! Jeśli nie możesz wstawiać obrazów, poszukaj ogólnych obrazów jako przykładu. Na przykład w sekcji Układ, krok 2 W tym samouczku konspekt wikiHow jest używany do zilustrowania sposobu tworzenia spisu treści.
  • Napisanie każdej sekcji na osobnej kartce papieru (lub na komputerze) ułatwi edycję. Możesz zmienić kolejność, jeśli potrzebujesz więcej informacji i możesz znaleźć edytowane punkty. Na komputerze zrób 3 lub 4 linie (naciskając wchodzić (nowa linia) kilka razy) między krokami można łatwo znaleźć przerwy.
  • Jeśli możesz, poproś nowicjusza, aby wypróbował Twojego przewodnika i zapisał pytania, które powinien zadać! Stamtąd będziesz mógł wypełnić puste miejsca i uczynić dokument bardziej użytecznym.