Jaki rodzaj dokumentu do projektowania gier? [Zamknięte]

Jakiego rodzaju wsparcia / formatu używasz do przechowywania i rozpowszechniania dokumentacji projektowej gry? Wiki? Pliki dokumentów? Pliki w repozytorium? Udostępniony folder? Dokument Google

Podaj zalety i wady każdego z nich.

Korzystam z Dokumentów Google, ponieważ wszystko, czego naprawdę potrzebuję, to edytor tekstowy online. Mogę stosunkowo łatwo współpracować z ludźmi online i wiem, że moje dane są tam bezpieczne na wypadek awarii mojego komputera.

Inną opcją wartą obejrzenia jest użycie Dropbox . Upuść tam dokument Word, a od razu masz środowisko współpracy z kontrolą wersji.

Wiki

Plusy:

• Najnowsza wersja zawsze dostępna w Internecie, poza witryną itp.
• Dość łatwy w użyciu (to znaczy, jeśli omijasz te z wrakiem pociągu do formatowania jak MediaWiki, to znaczy)
• Automatyczne indeksowanie, wyszukiwanie, łatwa kategoryzacja
• Łatwo przypisywać zmiany do ludzi i uczynić ich odpowiedzialnymi za zmiany
• Obsługuje linkowanie i ułatwia łatwe i skuteczne rozróżnianie szczegółów
• Może linkować do stron wiki bezpośrednio z wewnętrznych raportów o błędach i innej korespondencji, dzięki czemu weryfikacja błędu jest bardzo łatwa
• Historia wersji i kontrola wersji zazwyczaj wbudowane

Cons:

• Czasami ZBYT łatwa do zmiany (* patrz poniżej) i wymaga dyscypliny
• Strony mogą zsynchronizować się, gdy są edytowane w oderwaniu (często na przykład bez „globalnego wyszukiwania i zamiany”)
• Strony zostają osierocone lub zastąpione i pozostawione jako potencjalne pola minowe dla programistów później. ( „Co masz na myśli mówiąc, że już tego nie wdrażamy? Wciąż jest w wiki projektu!” )
• Składnia może być trochę ezoteryczna, chyba że otrzymasz odpowiedni pakiet
• Musisz zorganizować hosting lub zaakceptować to, co jest dostępne online za darmo
• Brak wyraźnej trasy przez dokument - w jaki sposób czytasz to „wszystko”?
• Trudne do wydrukowania. Czy możesz to wszystko wydrukować jednym kliknięciem? Czy możesz łatwo wydrukować wszystko, co dotyczy jednej funkcji, aby zabrać ją na spotkanie? Czy możesz łatwo dodać adnotację do wersji cyfrowej bez zasłaniania dokumentu bazowego?

(* Użyliśmy wiki dla jednego projektu, a projektanci zawsze mieli ochotę wejść i „ulepszyć” jej części, nawet w przypadku funkcji, które zostały podpisane i wysłane do zakodowania. Potem, kiedy QA przystąpiło do testowania tej funkcji, byłby koszmarem, ponieważ często projekt sugerowałby coś innego niż to, co faktycznie zostało zakodowane, i zajęłoby sporo frustrującej pracy, aby dowiedzieć się, co się stało najpierw, zmiana projektu lub kodu.)

Pliki tekstowe

W moim bieżącym projekcie używam prostych plików tekstowych w folderze „Docs” projektu, przechowywanym w repozytorium obok kodu.

Plusy:

• Dokumentacja jest przechowywana blisko faktycznej pracy, więc łatwo ją znaleźć.
• Proste formatowanie oznacza, że ​​utrzymanie dokumentacji jest łatwe i szybkie.
• Prosty format oznacza również niewielkie ryzyko utraty dokumentacji z powodu awarii serwera, uszkodzenia plików itp.
• Absolutnie minimalny czas konfiguracji sprawia, że ​​jest to świetny start dla pojedynczego dewelopera lub małych (2-3 osobowych) zespołów.
• Korzystanie z kontroli wersji oznacza, że ​​zmiany są śledzone i często można połączyć zmiany w dokumentacji bezpośrednio ze zmianą kodu.
• Praca z tekstem jest tak prosta, że ​​wyszukiwanie, edytowanie itd. Często można wykonywać za pomocą narzędzi wiersza poleceń.

Cons:

• Więcej niż kilku użytkowników i dokument łatwo zsynchronizuje się.
• Brak łączy, więc albo używasz jednego groteskowo dużego dokumentu, albo kilku mniejszych, ale niepowiązanych dokumentów.
• Ograniczone opcje formatowania i publikacji (choć konwersja, na przykład poprzez Markdown, jest łatwa do zrobienia).
• Praca z tekstem jest tak prosta, że ​​często jedynym sposobem wyszukiwania, zaawansowanej edycji itd. Jest użycie narzędzi wiersza poleceń.

Nie jest to coś, na czym chcesz polegać przy jakiejkolwiek pracy zespołowej, ale moc plików tekstowych w repozytorium, abyś mógł od razu zacząć pracę, nie powinien być niedoceniany dla pojedynczego programisty. Obecnie używam jednego dokumentu jako pewnego rodzaju przeglądu / master-plannera, który zawiera ogólny projekt, drugiego dokumentu, który działa jak lista rzeczy do zrobienia określonych rzeczy, których potrzebuje gra, trzeciego dokumentu jako luźnego narzędzia do śledzenia błędów i dokumentów pomocniczych w razie potrzeby opracuj „funkcję x”.

Nie używaj formatu / edytora dokumentu, który nie obsługuje wielu użytkowników (np. MS Word, Open Office Writer). Tylko jedna osoba może edytować dokument, a nawet przy kontroli źródła zbyt łatwo jest rozpocząć pracę nad nieaktualną wersją, a zapisując, że zasadniczo niszczysz wszystko, co zrobili inni użytkownicy od czasu ostatniej aktualizacji tej wersji dokumentu.

Foldery współdzielone są zdecydowanie najgorszym rozwiązaniem i absolutnie nie ma sensu dla żadnego rodzaju zasobu, nad którym powinno się pracować wspólnie. Nigdy nie możesz być pewien, że ktoś inny pracuje teraz nad tym plikiem lub zrobi to za kilka minut. Nie masz również śledzenia zmian i nie możesz wrócić do poprzedniej wersji w przypadku katastrofy (błąd ludzki, głupota lub zaniedbanie).

Najlepiej użyć Wiki, ale przyjaznego dla użytkownika i naprawdę WYSIWYG. Osobiście przysięgam na Confluence , która jest również używana w większych studiach twórców gier i kosztuje tylko 10 USD dla maksymalnie 10 użytkowników i nieograniczonej liczby widzów.

Większość innych stron wiki (MediaWiki, TikiWiki itp.) Ma tę wadę, że ma stromą krzywą uczenia się, a nawet jest praktycznie bezużyteczna dla personelu nietechnicznego. Nie dlatego, że nie mogli się tego nauczyć, ale (słusznie) nie akceptują korzystania z systemu dokumentów, który zasadniczo wymaga pisania kodu takiego jak HTML. Oto moje wkurzenie: Wiki, które mówią, że są WYSIWYG, ale wszystko, co robią, to wstawiają składnię do tekstu, który piszesz. To nie jest WYSIWYG!

Wytyczną dotyczącą korzystania z wiki jest umieszczanie każdego nagłówka na osobnej stronie, aby można było pociąć dokument na wiele części, którymi można zarządzać. Confluence oferuje funkcje, dzięki którym można agregować wszystkie te podstrony z powrotem w jedną stronę lub dokument, które można na przykład wyeksportować do formatu PDF.

Myślę, że One Note to dobra opcja. Jest to coś w rodzaju Wiki, ale z dużą obsługą edycji tekstu sformatowanego. Oprócz standardowego klienta stacjonarnego dostarczanego z pakietem Office dostępna jest wersja internetowa z pakietem Office Live . Szczerze mówiąc, uważam, że wersja internetowa, która jest darmowa, powinna wystarczyć na większość potrzeb, a w połączeniu ze Skydrive masz całkiem niezły system do współpracy nad dokumentem na żywo.

W jednym z moich projektów typu open source korzystaliśmy z (wstrzymującego się) programu SharePoint do przechowywania dokumentów i multimediów. Zarządzanie użytkownikami i uprawnieniami jest dość proste i obsługuje pełną historię wersji. Posiadamy witrynę SharePoint od około czterech lat, więc obecnie mogą być lepsze opcje. Jednak to nie działało bardzo dobrze dla nas. Jest obsługiwany przez firmę zewnętrzną (za około 20 USD / miesiąc), więc po wstępnej konfiguracji praktycznie nie było żadnej konserwacji z naszej strony. Oprócz obsługi bibliotek dokumentów i obrazów, SharePoint ma obsługę Wiki, chociaż nie jestem pewien, jak dobrze wypada w porównaniu z bardziej popularnymi silnikami Wiki.