Witaj Gościu! ( Zaloguj | Rejestruj )

Forum PHP.pl

> dokumentacja aplikacji, jak powinna wygladac?
AxZx
post
Post #1





Grupa: Zarejestrowani
Postów: 1 385
Pomógł: 55
Dołączył: 1.03.2005
Skąd: śląsk

Ostrzeżenie: (0%)
-----


witam

mam przygotowac dokumentacje juz gotowej aplikacji, ale nie wiem za bardzo jak taki dokument powinien wygladac.
czy mozna gdzies znalezc przykladowy konspekt?

chcialbym to w celu edukacyjnym, nie zarobkowym.
pozdrawiam
Go to the top of the page
+Quote Post
 
Start new topic
Odpowiedzi
AxZx
post
Post #2





Grupa: Zarejestrowani
Postów: 1 385
Pomógł: 55
Dołączył: 1.03.2005
Skąd: śląsk

Ostrzeżenie: (0%)
-----


wlasnie o to chodzi o czym napisal @empathon za co wielkie mu dzieki:)
phpdoc nie zrobi czegos takiego bo on chyba nie wie do czego ma sluzyc dana funkcja i nie umie opisac uzytkownikow itd.
wiem ze mozna w @description pisac, no ale bez przesady - tam mozna napisac ogolnikowy opis zeby miec rozeznanie w kodzie (jako programista).

ja myslalem zeby opisac to mniej wiecej tak:
  • uzyte narzedzia (jaki framework),
  • wykorzystane technologie (xhtml, php, css),
  • wykorzystane biblioteki (jquery, tinymce itd)
  • wzorce projektowe, architektura aplikacji (MVC)
  • uzytkownicy systemu (admin, klient)
  • funkcjonalnosc dla kazdego uzytkownika
dobrze kombinuje?
Go to the top of the page
+Quote Post
empathon
post
Post #3





Grupa: Zarejestrowani
Postów: 246
Pomógł: 31
Dołączył: 13.11.2006
Skąd: się znamy?

Ostrzeżenie: (0%)
-----


Cytat(AxZx @ 5.05.2008, 19:10:58 ) *
wlasnie o to chodzi o czym napisal @empathon za co wielkie mu dzieki:)
phpdoc nie zrobi czegos takiego bo on chyba nie wie do czego ma sluzyc dana funkcja i nie umie opisac uzytkownikow itd.
wiem ze mozna w @description pisac, no ale bez przesady - tam mozna napisac ogolnikowy opis zeby miec rozeznanie w kodzie (jako programista).

ja myslalem zeby opisac to mniej wiecej tak:
  • uzyte narzedzia (jaki framework),
  • wykorzystane technologie (xhtml, php, css),
  • wykorzystane biblioteki (jquery, tinymce itd)
  • wzorce projektowe, architektura aplikacji (MVC)
  • uzytkownicy systemu (admin, klient)
  • funkcjonalnosc dla kazdego uzytkownika
dobrze kombinuje?

Cieszę, że pomogłem. To o czym teraz napisałem będzie raczej modelem systemu z określeniem standardów i zakresu użycia gotowych komponentów. Bliżej temu do specyfikacji nie dokumentacji.
Myślę, że zainteresuje Cię książka z której cytowałem w poprzednim poscie. Kosztuje około 22 pln wiec na pewno nie stracisz (IMG:http://forum.php.pl/style_emoticons/default/winksmiley.jpg)

Ten post edytował empathon 5.05.2008, 18:24:34
Go to the top of the page
+Quote Post

Posty w temacie


Reply to this topicStart new topic
2 Użytkowników czyta ten temat (2 Gości i 0 Anonimowych użytkowników)
0 Zarejestrowanych:

 



RSS Aktualny czas: 12.10.2025 - 01:42