Dokumentacja użytkownika - przykłady dobre i złe
Wyszperane w sieci... a właściwie na stronach małej, rodzinnej firmy Blue Mango Learning System, twórcy produktów ScreenSteps i Clarity.
Wyszperane w sieci... a właściwie na stronach małej, rodzinnej firmy Blue Mango Learning System, twórcy produktów ScreenSteps i Clarity.
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.
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.
Nieważne jak bardzo lubimy swoją pracę, to jednak z czegoś trzeba żyć. Jest to kwestia dużej wagi, dlatego wracamy do niej po kilku miesiącach od ostatniego postu w tym temacie. Dzisiaj pytamy jak się żyło dokumentalistom w roku 2013.
Znacie program Word i wiecie jak go używać? Jesteście w mniejszości, prawda? Co jakiś czas przychodzi do Was ktoś, komu znów "rozjechał się dokument"? A gdyby tak przestał przychodzić?