Temat: w czym pisać dokumentacje

Witam

Za pomocą jakich programów piszecie dokumentacje użytkownika czyli manuale ? Zna coś takie jak help and manual, ale z chęcią przesiadł bym się na coś innego. Co polecacie/ stosujecie?
Anna R.

Anna R. REQB | ISTQB

Temat: w czym pisać dokumentacje

W MS Word, klasyka gatunku :)
Krzysztof Kukla

Krzysztof Kukla Test Manager

Temat: w czym pisać dokumentacje

MS Word + eksport do PDF
Krystian K.

Krystian K. Agile Coach, Autor

Temat: w czym pisać dokumentacje

Anna R.:
W MS Word, klasyka gatunku :)

Co to, to nie. Klasyką gatunku jest LaTeX http://www.latex-project.org/

U mnie też dziobią w MS Word ale bez eksportu do PDF. Teraz zaczyna to boleć, bo nowsze maszyny mają wersję 2007 a starsze 2003.

konto usunięte

Temat: w czym pisać dokumentacje

Calkowicie popieram Krystiana. Tylko LateX.
Wszystko inne po jakims czasie zacznie odbijac sie czkawka ;)

konto usunięte

Temat: w czym pisać dokumentacje

Pawel K.:
Calkowicie popieram Krystiana. Tylko LateX.
Wszystko inne po jakims czasie zacznie odbijac sie czkawka ;)

LaTeX jest dobry do pisania prac naukowych albo składania książek.

konto usunięte

Temat: w czym pisać dokumentacje

Ostatnio interesuje się systemami Atlassian, i twierdzą, że w Confluence można trzymać dokumentacje i jest plug-in, który to składa np. do PDFów albo DocBooków.
Nie testowałam, nie wiem, ale idea mi się podoba :)

konto usunięte

Temat: w czym pisać dokumentacje

Wojciech Czaplinski:
Pawel K.:
Calkowicie popieram Krystiana. Tylko LateX.
Wszystko inne po jakims czasie zacznie odbijac sie czkawka ;)

LaTeX jest dobry do pisania prac naukowych albo składania książek.

Dokumentacja moze miec 50,100 a nawet 500 stron

konto usunięte

Temat: w czym pisać dokumentacje

Pawel K.:

Dokumentacja moze miec 50,100 a nawet 500 stron

OK, tu trzeba sprecyzować co rozumiemy przez "dokumentację".

Temat: w czym pisać dokumentacje

Piszę dokumentację użytkownika czyli po prostu instrukcję:) To jest w sumie kilka dokumentów. I szlak mnie trafia, bo Help and Manual, który niby do tego się nadaję jest koszmarny. Tekst jest po konwersji do pdfa poprzesuwany, podczas pisania w nim nie ma podziału storny, robi się go samemu, nie wiem czy już zapisałem stronę czy jeszcze nie. Niby to wygląda ok, niby są wszyscy zadowoleni, ale nie ja :P A to ja odpowiadam za jakość. Kiedyś dawno temu, pisałem w wordzie i tu nie narzekałem, ale to nie jest dedykowane narzędzie? Latex, może ok. Już sam nie wiem......
Łukasz Ż.

Łukasz Ż. Quality Assurance
Team Lead, Mentor
Graphics

Temat: w czym pisać dokumentacje

Hej,

Jak juz powiedzieli przedmowcy - LaTex. Raz zdefiniujesz sobie styl a potem tylko piszesz i sie o nic nie martwisz. Natomiast jesli masz tylko pare stron do napisania i zalezy Ci na czasie (LaTex wymaga troche czasu zeby sie do niego przyzwyczaic) to polecam OpenOffice -> Writer (OpenDocument) i wynik eksportowac do PDF - OO ma wbudowany mechanizm, nie potrzebujesz drukarek itp. po prostu robisz Export to PDF i o nic sie nie martwisz :) kiedy ja uzywalem nic mi nie przesuwalo (tabel, zdjec itp)

Pozdrawiam,
Lukasz
Krzysztof Czeronko

Krzysztof Czeronko Senior Test Enginer,
Tieto Poland Sp. z
o.o.

Temat: w czym pisać dokumentacje

Witam.

Również polecam LaTeX'a. Zapoznanie się z nim trochę potrwa ale potem bardzo ułatwi dalszą pracę. Najlepsze jest to, że można dosyć precyzyjnie kontrolować wstawianie elementów - obrazki, wzory, itp na stronie - nie trzeba się tak męczyć jak z wordem. Aczkolwiek pisanie w LaTeX przypomina nieco HTML.
Bartosz Jarzębski

Bartosz Jarzębski Head of Quality
Assurance in
Delivery Assurance

Temat: w czym pisać dokumentacje

Łukasz Ż.:
polecam OpenOffice -> Writer (OpenDocument) i wynik eksportowac do PDF - OO ma wbudowany mechanizm, nie potrzebujesz drukarek itp. po prostu robisz Export to PDF i o nic sie nie martwisz :) kiedy ja uzywalem nic mi nie przesuwalo (tabel, zdjec itp)

Nowy Word tez ma export do PDF.
Piotr D.

Piotr D. Tester
Oprogramowania

Temat: w czym pisać dokumentacje

Tak na mój gust, to przynajmniej w większości zastosowań mogłaby się sprawdzić taka pozornie karkołomna kombinacja - dobrze skonigurowane oprogramowanie typu Wiki z dostosowywalnym wersjonowaniem i eksportem do samodzielnie definiowanych szablonów np. Worda i PDF.

Nie szukałem zbyt intensywnie, ale takiego kombajnu wszystko w jednym mnie widziałem. Zawsze był jakiś haczyk - np. mój uwielbiany Confluence jakoś nieskładnie PDFy produkował. Tzn. na wewnętrzne potrzeby PDFik był OK, ale nie wyglądał na tyle ładnie i profesjonalnie aby mógł zostać wysłany do klienta.

Nie wydaje mi się, aby wśród licznej grupy użytkowników MS Word (i podobnych) wielu potrafiło posługiwać się nim profesjonalnie, tj. za pomocą styli, trzymając cała hierarchię dokumentu itp (ja nie potrafię) a wtedy łatwo rozjechać dokument i masowe zmiany robią się trudne.

Dlatego - szczególnie w organizacjach, bo indywidualnie to najlepiej pisać w tym co się najlepiej zna - ja bym sugerował oddzielnie treści i układu od pliku wynikowego, który powinien być generowany do postaci finalnej ze wskazanej wersji, a nie "rzeźbiony ręcznie".

I jest pewnie od groma i trochę komercyjnych, dedykowanych rozwiązań na skalę wręcz przemysłową - ale sprawę znam ze słyszenia i tutaj jakiś Technical Writer z jakiejś Wielkiej Korporacji pewnie mógłby coś powiedzieć.Piotr D. edytował(a) ten post dnia 08.04.10 o godzinie 22:43

konto usunięte

Temat: w czym pisać dokumentacje

Ja chętnie dowiem się czego ciekawego używać, małym kosztem, o funkcjonalności pomiędzy Wordem a Latexem. Jednak aż tak skomplikowana ta dokumentacja nie jest, a jakbym to wrzuciła w Latexa, to pół firmy by mnie ubiło (ludzie typu 'o fuuj, używasz opcji Review w Wordzie, nie cierpię tego).

Ale fakt, jak człowiek na poważniej siądzie przy stylach Wordowych, to się czasem trafia na ścianę :/

Może html+css i jakiś konwerter tego na pdf'y? :)
Piotr D.

Piotr D. Tester
Oprogramowania

Temat: w czym pisać dokumentacje

Agata S.:
Może html+css i jakiś konwerter tego na pdf'y? :)

1. słabo widzę przygotowanie do wydruku, szczególnie rozdział po stronach
2. jeżeli juz, to może lepiej XML + XSLT ? - wizualnie w przeglądarce będzie podobnie, a mimo wszystko łatwiej chyba będzie do tego jakiś automacik napisać w razie potrzeby....

Następna dyskusja:

Czym jest ITIL(R)? Wprowadz...




Wyślij zaproszenie do