Skocz do zawartości

Rekomendowane odpowiedzi

Ma ktoś jakieś doświadczenia z tworzeniem dokumentacji do gry? Do tej pory pracowałem w większości sam, ale teraz tworząc StellarArk staram się myśleć bardziej przyszłościowo i jako, że przewiduję w przyszłości zatrudnienie programistów do dalszego jej rozwoju, pasowałoby mi już teraz zacząć tworzyć dokumentację do niej. 

Możecie coś polecić? Jakiś kurs jak tworzyć taką dokumentację, albo programy ułatwiające to. Będę na pewno grzebał w google w tym temacie, no ale tu można czasem odkopać guano i nie znając się na tematyce uznać je za coś wartościowego i potem tworzyć kierując się głupimi zasadami ;) 

Udostępnij tego posta


Odnośnik do posta
Udostępnij na innych stronach

Ja używam google docs + wiki + diagramPainter + paint

Google docs z powodu łatwości w dzieleniu się tym i edycji. Jest to dobre w dalszej fazie projektu, gdy mało komu chce się edytować wiki. Wiki natomiast jest dobra jako punkt startowy, gdyż łatwiej się ją przegląda.

Generalny opis możesz bez problemu napisać w wordzie, wesprzeć go diagramami i grafikami. Pewne zestawienia danych w spreadsheecie .

Ten jest spoko, choć ja wolę używać większej ilości grafik http://www.gamasutra.com/view/feature/130127/design_document_play_with_fire.php

Udostępnij tego posta


Odnośnik do posta
Udostępnij na innych stronach
14 godzin temu, Jimmyblack napisał:

Google docs z powodu łatwości w dzieleniu się tym i edycji. Jest to dobre w dalszej fazie projektu, gdy mało komu chce się edytować wiki. Wiki natomiast jest dobra jako punkt startowy, gdyż łatwiej się ją przegląda.

Generalny opis możesz bez problemu napisać w wordzie, wesprzeć go diagramami i grafikami. Pewne zestawienia danych w spreadsheecie.

Wiki tworzę dla graczy, potrzebuję natomiast rozwiązania dla przyszłych programistów, którzy kiedyś przejmą projekt. Komentarze w kodzie są, zmienne, funkcje, klasy też staram się nazywać zrozumiale, ale obawiam się że to może być nieco mało jeśli projekt się rozrośnie.

To że w wordzie, albo notatniku mogę stworzyć to ja wiem :P Szukam czy aby nie ma czegoś, co by ten proces ułatwiło ;)

Udostępnij tego posta


Odnośnik do posta
Udostępnij na innych stronach

Do design docsów używamy właśnie tego, co napisałem powyżej. Teraz właśnie zauważyłem, że Tobie raczej chodzi o coś innego. Zboczenie designera, moja wina :)

Czyli jeśli dobrze zrozumiałem, sam właśnie tworzysz kod i chcesz, aby ktoś, kto będzie go klepał dalej orientował się w nim dobrze.

Mogę podpytać, jak radzą sobie z tym nasi programiści i dać Ci znać w czwartek.

Udostępnij tego posta


Odnośnik do posta
Udostępnij na innych stronach

Dobrze napisany kod sam się dokumentuje. Dodatkowo - komentarze robione dla każdej funkcji i klasy opisujące parametry i membry mogą w łatwy sposób zostać przekonwertowane na dokument. Dla Javy jest narzędzie Javadoc, dla innych języków też istnieją narzędzia działające identycznie, wspomniany Sphinxdoc wygląda dobrze. To jest jedyna słuszna metoda. Nie wyobrażam sobie jednoczesnego edytowania kodu i jakiegoś pliku z opisem, w dużych projektach tak się po prostu nie da.

Udostępnij tego posta


Odnośnik do posta
Udostępnij na innych stronach

Jeśli chcesz dodać odpowiedź, zaloguj się lub zarejestruj nowe konto

Jedynie zarejestrowani użytkownicy mogą komentować zawartość tej strony.

Zarejestruj nowe konto

Załóż nowe konto. To bardzo proste!

Zarejestruj się

Zaloguj się

Posiadasz już konto? Zaloguj się poniżej.

Zaloguj się


  • Przeglądający   0 użytkowników

    Brak zarejestrowanych użytkowników, przeglądających tę stronę.

×