Projekt bazy danych - dokumentacja
Flipi - 09-12-2005 19:53
Projekt bazy danych - dokumentacja
Witam,
Czy ktoś z was ma może przykład dokumentacji bazy danych?
Chodzi o mniej więcej taki schemat:
1. Założenia projektu (cel i zakres aplikacji)
2. Schematy tabel
3. Opisy funkcji projektu
Z samym projektowaniem tabel/baz nie ma problemu chodzi mi jedynie o te
literackie wypociny ;) Jak to ładnie ująć żeby było dobrze.
Może ktoś zna jakieś strony gdzie będą informacje jak taka dokumentacja
powinna wyglądać.
Z góry dzięki za wszelką pomoc.
--------------
Pozdrawiam,
Flipi
Wojtek pBT (lapt) - 09-12-2005 19:54
Dnia 2005-12-07 10:18, Użytkownik Flipi napisał:
> Witam,
>
> Czy ktoś z was ma może przykład dokumentacji bazy danych?
> Chodzi o mniej więcej taki schemat:
> 1. Założenia projektu (cel i zakres aplikacji)
> 2. Schematy tabel
> 3. Opisy funkcji projektu
>
> Z samym projektowaniem tabel/baz nie ma problemu chodzi mi jedynie o te
> literackie wypociny ;) Jak to ładnie ująć żeby było dobrze.
> Może ktoś zna jakieś strony gdzie będą informacje jak taka dokumentacja
> powinna wyglądać.
Robisz pod promotora...
add 1) to co ma robić, a nie jak
add 2) id | klucz głowny | int | autonumer | nadawane przez system
|maska (Czyli to co uważasz za słuszne) -- jalepiej posłóż się akcesem
aby wygenerować sobie przykładowy opis
add 3) to co w 1) ale o wiele bardziej szczegułowo
pBT
=?ISO-8859-2?Q?S=B3awomir_Szysz=B3o?= - 09-12-2005 19:54
Dnia Wed, 07 Dec 2005 10:18:05 +0100, Flipi <flipi.no@spam.poczta.fm>
wklepał(-a):
>Z samym projektowaniem tabel/baz nie ma problemu chodzi mi jedynie o te
>literackie wypociny ;) Jak to ładnie ująć żeby było dobrze.
>Może ktoś zna jakieś strony gdzie będą informacje jak taka dokumentacja
>powinna wyglądać.
Zasada nr 1 brzmi - pisz dokumentację tak, żeby inna osoba mogła to zrozumieć
bez większych problemów. Czyli nie pisz, że pole A jest znakowe o rozmiarze X bo
to wynika z samego schematu. Ewentualnie można dołączyć listing tabel na końcu
dokumentacji. Ważniejsze jest opisanie sensu powiązań między tabelami,
zależności pomiędzy polami albo rekordami (jeśli używasz jakiegoś rodzaju
wersjonowania czy kluczy typu "ucho"). Nie zawsze klucz obcy w tabeli oznacza,
że w tabeli "podrzędnej" może być wiele rekordów - być może aplikacja pilnuje,
żeby faktycznie relacja była 1:1, ale z jakichś powodów potrzebny jest klucz.
Pisz o takich rzeczach, które nie wynikają wprost ze schematu. Tak, żeby ktoś
czytając tą dokumentację potrafił zrozumieć, jak działa aplikacja korzystająca z
tej bazy i ewentualnie jak ją modyfikować/rozszerzać.
--
Sławomir Szyszło mailto:slaszysz@poczta.onet.pl
Primus inter FAQires & Grand Inquisitor no.0 of pl.comp.bazy-danych
FAQ pl.comp.bazy-danych http://www.dbf.pl/faq/
Archiwum http://groups.google.com/groups?grou...mp.bazy-danych
Flipi - 13-12-2005 09:34
Sławomir Szyszło napisał(a):
> Zasada nr 1 brzmi - pisz dokumentację tak, żeby inna osoba mogła to zrozumieć
> bez większych problemów. Czyli nie pisz, że pole A jest znakowe o rozmiarze X bo
> to wynika z samego schematu. Ewentualnie można dołączyć listing tabel na końcu
> dokumentacji. Ważniejsze jest opisanie sensu powiązań między tabelami,
> zależności pomiędzy polami albo rekordami (jeśli używasz jakiegoś rodzaju
> wersjonowania czy kluczy typu "ucho"). Nie zawsze klucz obcy w tabeli oznacza,
> że w tabeli "podrzędnej" może być wiele rekordów - być może aplikacja pilnuje,
> żeby faktycznie relacja była 1:1, ale z jakichś powodów potrzebny jest klucz.
>
> Pisz o takich rzeczach, które nie wynikają wprost ze schematu. Tak, żeby ktoś
> czytając tą dokumentację potrafił zrozumieć, jak działa aplikacja korzystająca z
> tej bazy i ewentualnie jak ją modyfikować/rozszerzać.
Dzięki za informację.
Pozdrawiam,
Flipi
zanotowane.pldoc.pisz.plpdf.pisz.pleffulla.pev.pl
|
[MSSQL2000] Problem z =?ISO-8859-2?Q?tabel=B1/indeksem/zapytanie?==?ISO-8859-2?Q?m_czy_b=B3=B1d_w_bazie_danych=2E=2E=2E?=
[laik]Jak =?ISO-8859-2?Q?stworzy=E6/zaczac_tworzyc__ma=B3=B1?==?ISO-8859-2?Q?__baz=EA_danych_na_potrzeby_www=3F?=
[mysql] przenoszenie danych =?ISO-8859-2?Q?mi=EAdzy_tabelami_?==?ISO-8859-2?Q?w_r=F3=BFnych_bazach?=
Ksiazka - "Podstawowy =?ISO-8859-2?Q?wyk=B3ad_z_system=F3w_?==?ISO-8859-2?Q?baz_danych=22?=
Zrywanie =?ISO-8859-2?Q?po=B3aczen_z_baza_danych_-_pos?==?ISO-8859-2?Q?tgresql_=3C-=3E_odbc?=
=?iso-8859-2?Q?=5BSQL_Server_2000=5D_uprawnienienia_do_u=BFyw ania_widoku_?==?iso-8859-2?Q?opartego_na_tabeli_z_innej_bazy?=
Dwie bazy czy dwie tabele?
[PHP i MySQL] Wstawianie =?ISO-8859-2?Q?rekord=F3w_do_bazy_?==?ISO-8859-2?Q?a_z=B3e_kodowanie?=
[mssql] insert do tabeli na podstawie danych z innej tabeli
=?ISO-8859-2?Q?=5Bmysql=5D_synchronizacja_struktury_bazy_?==? ISO-8859-2?Q?lokalnej_ze_zdaln=B1?=
zanotowane.pldoc.pisz.plpdf.pisz.plshanti.opx.pl
Cytat
Decede mihi sole - nie zasłaniaj mi słonca.
Gdy kogoś kochasz, jesteś jak stworzyciel świata - na cokolwiek spojrzysz, nabiera to kształtu, wypełnia się barwą, światłem. Powietrze przytula się do ciebie, choćby był mróz, a ty masz w sobie tyle radości, że musisz ją rozdawać wokoło, bo się w tobie nie mieści
Hoc fac - tak czyń.
A tergo - od tyłu; z tyłu.
I czarne włosy posiwieją. Safona |
|
