Scott Tiger Tech Blog

Blog technologiczny firmy Scott Tiger S.A.

DocBook

Autor: Piotr Karpiuk o 29. listopada 2011


Wygenerowany z DocBooka format Web Help. Projekt powstał powstał podczas Google Summer of Code 2010. Kliknij aby obejrzeć na żywo.

Dokumentacja produktów firmy informatycznej – w jakim formacie i jak wyobrażamy sobie optymalny proces jej wytwarzania? Często traktowana po macoszemu, powstaje ad hoc w MS Wordzie. Tymczasem chciałoby się mieć:

  • spójny wygląd dokumentów firmy,
  • tak naprawdę przydałyby się różne formaty wynikowe: przynajmniej PDF do wydruku i HTML do dokumentacji online,
  • możliwość przeszukiwania i wygodnego przeglądania wszystkich dokumentów dotyczących jednego produktu, ale może również dokumentów wszystkich produktów firmy,
  • wersjonowanie, z możliwością ustalenia kto, kiedy, gdzie i dlaczego naniósł jakieś poprawki,
  • fragmenty dokumentacji mogłyby być generowane automatycznie, np. z komentarzy w kodzie źródłowym lub ze schematu bazy danych.

Dziś będzie o DocBooku, który moim zdaniem z gracją odnosi się do tak postawionych wymagań. Na początek kliknij w rysunek po prawej, który przedstawia jeden z możliwych docelowych formatów dokumentacji wygenerowanej z tego narzędzia. Zwróć uwagę na pełnotekstowe przeszukiwanie i spis treści w postaci drzewka.

Czytaj więcej »

Tags: ,
Napisany w DTP | Brak komentarzy »