Pisanie instrukcji to nic trudnego. Pisanie dobrych instrukcji to całkowicie inna historia. To nie lada wyzwanie wymagające odpowiedniego podejścia i umiejętności. Dzisiaj chcemy Wam przedstawić kilka wskazówek jak pisać skuteczne instrukcje. Przepis pochodzi z blogu Laury Schneider. Oryginalny artykuł można znaleźć tutaj. Poniżej przedstawiamy streszczenio-tłumaczenio-interpretację tegoż artykułu. 😊
[Help and Manual](../help-and-manual-opis-narzedzia/ 'Help and Manual – opis narzędzia'index.md) posiada dużo przydatnych funkcji, których nie widać gołym okiem. Jedną z nich jest możliwość sprawdzenia, które obrazki nie są używane w projekcie.
Podejście minimalistyczne w pisaniu dokumentacji jest jak najbardziej wskazane, o czym wspominaliśmy w jednym z postów jakiś czas temu. Długie, skomplikowane i przeładowane informacjami instrukcje to samo zło, którego należy unikać.
W pracy każdego Technical Writera przychodzi co jakiś czas moment wytchnienia. Możemy złapać spokojnie oddech i zwolnić tempo. Pojawia się trochę wolnego czasu. Jedni chcą wtedy po prostu cieszyć się chwilą, ale inni wolą ten czas spożytkować na naukę obsługi nowych narzędzi do tworzenia dokumentacji Help Authoring Tools.
Przeglądając wpisy na różnych blogach dotyczących komunikacji technicznej, zauważyliśmy ostatnimi czasy sporo informacji, które wieszczą powolny schyłek naszej profesji. Powodem takiego stanu rzeczy nie jest chęć zastąpienia człowieka maszyną, o czym wspominaliśmy jakiś czas temu w jednych z artykułów, ale ogólna tendencja w produkcji oprogramowania.