218 artykułów z tagiem "warsztat"

Jedną z cech dobrego Technical Writera jest umiejętność pisania. Na tą umiejętność składają się różne elementy, takie jak prezentowanie informacji w sposób jasny i zrozumiały czy też uporządkowanie ich w logiczny sposób. Ale to nie wszystko. Liczy się również poprawność językowa. Pomimo tego, że jest ona na pewno mniej ważna niż dokładność przedstawianych informacji, to nie powinniśmy o niej zapominać. Wiadomo, w sytuacji kiedy mamy napięte terminy i musimy z czegoś zrezygnować, lepiej jest stworzyć dokumentację zawierającą błędy językowe, ale dokładną pod względem technicznym niż wzór poprawności językowej, który opisuje produkt "po łebkach".

Zgodnie z obietnicą, prezentujemy drugą porcję przydatnych informacji z książki „Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation” autorstwa Alana S. Pringle i Sarah S. O’Keefe. Jest to kontynuacja dobrych rad, które przedstawiliśmy w poprzednim wpisie z cyklu "Naucz się sam(a)".

Nadszedł czas, żeby zabrać się za zawartość przesyłki, którą opisywaliśmy w poprzednim wpisie z cyklu "Naucz się sam(a)". Zaczynamy od książki "Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation" autorstwa Alana S. Pringle i Sarah S. O'Keefe.

A może po prostu Style Guide lub Style Manual? Dowiedz się co to jest, sprawdź do czego i kiedy jest potrzebne, stwórz Style Guide dla swojej organizacji. O ile jeszcze go nie ma.

Markdown jest popularnym językiem znaczników. Niektórzy używają go do tworzenia dokumentów, inni do pisania artykułów. Sam Tom Johnson nie tak dawno pisał na swoim blogu, o własnym pomyśle na tworzenie dokumentacji w Markdownie przy użyciu Google Docs, Google Sites i stackedit.io. W normalnej sytuacji, dokumentaliści czy inni "pisarze" używają do pracy komputera. Ale co zrobić kiedy pod ręką mamy tylko komórkę i musimy coś na szybko sklecić właśnie w Markdownie? Oczywiście takie sytuacje zdarzają się niezwykle rzadko, ale licho nie śpi 😉 Jeśli posiadamy komórkę z Androidem to jest nadzieja. Możemy skorzystać z jakiegoś edytora wspierającego ten język znaczników. Tylko z którego? W sklepie Google Play mamy całkiem spory wybór darmowych i płatnych narzędzi. Wiele z nich oferuje bardzo zbliżoną funkcjonalność. Wybraliśmy trzy darmowe edytory, które spełniają różne potrzeby, zarówno te mniejsze jak i te większe.