Help and Manual to aplikacja do tworzenia dokumentacji, która oferuje całkiem sporo możliwości. Jakiś czas temu opisywaliśmy to narzędzie. Tym, którzy szukają dodatkowych funkcji proponujemy zapoznanie się z aplikacją Help & Manual Toolbox.
Nie boisz się wyzwań jakie stawia dokumentacja techniczna? Jeśli tak, to na pewno zainteresuje Cię webinarium zorganizowane 29 maja przez soap!. Tom Johnson, znany i ceniony Technical Writer, autor blogu I'd Rather Be Writing, poprowadził prezentację internetową pod nazwą "Creating code samples for API/SDK documentation". Tom od ponad roku zajmuje się dokumentacją dla interfejsów programowania aplikacji (API) i zestawów narzędzi dla programistów (SDK). Studiował język angielski, nigdy nie był programistą, dlatego rozumie wątpliwości osób, które zaczynają swoją przygodę z dokumentacją dla programistów. W swojej prezentacji starał się odpowiedzieć na 20 pytań dotyczących umieszczania próbek kodu w dokumentacji API/SDK. Poniżej prezentujemy najciekawsze według nas zagadnienia.
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.