GoldenLine
Zaloguj się
Krzysztof Raczkowski

Krzysztof Raczkowski Stała współpraca,
Logifact-Systems Sp.
z o.o.

Temat: Docbook a dokumentacja bazy danych (trochę SPAM ;) )

Witam,

Od jakiegoś dłuższego czasu pracuję nad koncepcją/aplikacją umożliwiającą sprawną dokumentację i utrzymanie dokumentacji (to chyba większe wyzwanie) istniejącej bazy danych.
Idea działania takiej aplikacji opisana jest tu: DB2Docbook
Będę wdzięczny za wszelkie uwagi :), miłego weekendu.

--
Pozdr.
K.R.
Link do wypowiedziLink

konto usunięte

Temat: Docbook a dokumentacja bazy danych (trochę SPAM ;) )

Krzysztof Raczkowski:
Witam,

Od jakiegoś dłuższego czasu pracuję nad koncepcją/aplikacją umożliwiającą sprawną dokumentację i utrzymanie dokumentacji (to chyba większe wyzwanie) istniejącej bazy danych.
Idea działania takiej aplikacji opisana jest tu: DB2Docbook
Będę wdzięczny za wszelkie uwagi :), miłego weekendu.

Ciekawa idea.
Czy ten proces korzysta w jakiś sposób z istniejącej dokumentacji?
Np.
DB2 COMMENT?
Jest gdzieś przykład raportu wynikowego?
Przydałoby się żeby generowany HTML był z hiperlinkami - przechodzenie przez referencje, np. "ta kolumna występuje także w..." lub "ta procedura korzysta z tabel: ".
Link do wypowiedziLink

konto usunięte

Temat: Docbook a dokumentacja bazy danych (trochę SPAM ;) )

W sumie to się zastanawiam, czy nie lepiej texa (czyt. techa ;) użyć. Oddzielenie treści od prezentacji jest jednym z założeń tego systemu. W przypadku utrzymania dokumentacji - to podstawa. Jak firma zmienia logo, albo inną rzecz z nagłówka - jeden ruch i zmienione. Z drugiej strony - tex to potężne działo - nie zawsze jest potrzebne.
Link do wypowiedziLink
Krzysztof Raczkowski

Krzysztof Raczkowski Stała współpraca,
Logifact-Systems Sp.
z o.o.

Temat: Docbook a dokumentacja bazy danych (trochę SPAM ;) )

Michał Z.:
W sumie to się zastanawiam, czy nie lepiej texa (czyt. techa ;) użyć. Oddzielenie treści od prezentacji jest jednym z założeń tego systemu. W przypadku utrzymania dokumentacji - to podstawa. Jak firma zmienia logo, albo inną rzecz z nagłówka - jeden ruch i zmienione. Z drugiej strony - tex to potężne działo - nie zawsze jest potrzebne.

Też o tym myślałem - tex jest przyjaźniejszy jak ktoś ma tylko notepad++ no i lepiej wspiera wersje do wydruku. Docbook z racji tego iż jest to XML jest o niebo prostszy do parsowania i aktualizacji dokumentacji.
Swoją drogą istnieje opcja przekonwertowania Docbook-a do tex-a jeżeli ktoś bardzo chce.
Link do wypowiedziLink
Krzysztof Raczkowski

Krzysztof Raczkowski Stała współpraca,
Logifact-Systems Sp.
z o.o.

Temat: Docbook a dokumentacja bazy danych (trochę SPAM ;) )

Piotr Likus:

Ciekawa idea.
Czy ten proces korzysta w jakiś sposób z istniejącej dokumentacji?
Np.
DB2 COMMENT?
Jest gdzieś przykład raportu wynikowego?
Przydałoby się żeby generowany HTML był z hiperlinkami - przechodzenie przez referencje, np. "ta kolumna występuje także w..." lub "ta procedura korzysta z tabel: ".

Co do do komentarzy z bazy - zobaczymy chciałbym na razie uniknąć stosowania dedykowanych bibliotek lub parsowania sql-a. Na razie opieram się na tym co znajdę w INFORMATION_SCHEMA.

Co do linków/hiperlinków - to oczywiście. Każdy obiekt bazodanowy dostaje w dokumentacji swoje unikalne Id - w ten sposób w bardzo prosty sposób można się do niego odwołać w opisie logiki. Co do generowania automatycznych linków przez aplikację na pewno będzie to robione dla FK, indeksów. Co do zależności (w sensie procedura używa tabeli itp...) to nie jest to już trywialne :)

Przykład jest tu: http://www.proitsoft.com.pl/db2docbook.html (załączniki na dole).

--
Pozdrawiam
K.R.
Link do wypowiedziLink

konto usunięte

Temat: Docbook a dokumentacja bazy danych (trochę SPAM ;) )

Co do texa zamiast docbooka - coś za coś. Nie mam mocnego faworyta, dobrze, że był brany pod uwagę.

Dokumentacja bazy danych jest częścią większej całości i z nią żyje. Jest ściśle związana z DAO, czy tam innymi ORMami... Zmierzam do tego, że jest coś takiego jak hibernate tools i tam też mogę wygenerować dokumentację. Ta dokumentacja będzie stanowić część opisu systemu - SADa, czy tam czegoś. Rozumiem, że nie każdy soft powstaje w javie, dokumentacja bazy danych jako osobna część też może się przydać. Zwłaszcza jak ktoś używa docbooka. Wtedy wystarczy wpiąć. No, ale chętnie bym widział modułowy układ, który pozwoli na dobre radzenie sobie np. z komentarzami w bazie. Postgres pozwala na komentarze na poziomie kolumn - zrobienie czegoś, co wyciąga to do texa - jest dość szybkie. Problem tylko z utrzymaniem tego później :) Jak by się dało nad tym jakoś sensownie zapanować - byłoby miło.
Link do wypowiedziLink
Krzysztof Raczkowski

Krzysztof Raczkowski Stała współpraca,
Logifact-Systems Sp.
z o.o.

Temat: Docbook a dokumentacja bazy danych (trochę SPAM ;) )

Michał Z.:
Postgres pozwala na komentarze na poziomie kolumn - zrobienie czegoś, co wyciąga to do texa - jest dość szybkie. Problem tylko z utrzymaniem tego później :) Jak by się dało nad tym jakoś sensownie zapanować - byłoby miło.

Każda z tych baz na, których się na razie skupiłem ma komentarze (nie jestem pewien MySQL) i każda to przechowuje w trochę inny sposób, a ja chciałbym się na razie skupić na wspólnym mianowniku :)

Co do samej idei wyciągania komentarzy z bazy to moim zdaniem ma to sens wtedy gdy obiekt nie ma komentarza, jeżeli obiekt ma komentarz to powinien być zachowany raczej ten komentarz z dokumentacji. Inaczej mówiąc komentarze z bazy to taki 'lepszy rydz niż nic' :)

--
Pozdr.
K.R.
Link do wypowiedziLink
« Wróć do tematów
Odpowiedz

Podobne tematy


Następna dyskusja:

Forum Bazy Danych




Wyślij zaproszenie do
Anuluj