Autor Wątek:  Dokumentacja dla użytkowników Symulatora  (Przeczytany 15086 razy)

0 użytkowników i 1 Gość przegląda ten wątek.

Offline adzik

  • Wiadomości: 58
    • Zobacz profil
  • Otrzymane polubienia: 0
Dokumentacja dla użytkowników Symulatora
« dnia: 27 Czerwca 2011, 17:29:49 »
Witam!
Śledząc na bieżąco wydarzenia związane z aktualizacją szaty graficznej forum jak i strony głównej zauważam brak informacji odnośnie sporządzania dokumentacji Symulatora w wersji "przystępnej dla użytkowników", tak, by zawarte tam informację odpowiadały na 90% pytań rodzących się w głowach nowicjuszy jak i średnio-zaawansowanych. W tym miejscu pragnąłbym wyrazić chęć pomocy w tym kierunku i stworzyć takową "Encyklopedię Wiedzy" zgromadzoną u nas. Niemniej jednak bez zgody Administracji czy Kierownictwa, samowolne tworzenie będzie zbyt nieefektywnym marnowaniem czasu i energii.
Dlatego mając na uwadzę wcześniejszą ofertę chciałbym dowiedzieć się czy mógłbym zająć się zagadnieniem, a także, w przypadku udzielenia pozytywnej odpowiedzi, nad czym powinienem skupić swoje starania.

Dla mnie oczywistym stworzenie będzie stworzenie dokumentacji w:
  • Instalowanie i pobieranie Symulatora
  • Działanie startera Ra lub inaczej mówiąc Uruchamianie Symulatora/Scenerii
  • FAQ - czyli Najczęściej zadawane pytania + błędy popełniane przez nowych użytkowników
  • Obsługa Maszyn w Symulatorze (opis funkcji + zdjęcia, działanie)
  • Video Tutorial - Filmy instruktażowe
  • Specyfikacja plików - rozpisane instrukcje i parametry - z czym co się je
  • ... wiele wiele innych
Na chwilę zakładania tego wątku i na początek myślę że to wystarczająca lista startowa, z czasem uzupełniana o nowe pozycję (zapewne metodą burzy mózgów forumowiczów). I tu chciałbym zadać pytanie do ogółu - czego w dokumentacji brakuje, co mogłoby być na stronie EU07.pl?
No i najważniejsze, jakie jest stanowisko Kierownictwa?


Link do tworzącej się dokumentacji:
https://docs.google.com/document/d/1To7KQKW9YudMfCpsGkkPUHStQagBWd8WtWl1-wLZERE/edit?hl=pl&authkey=COnviaQFPozdrawiam, adzik.
« Ostatnia zmiana: 27 Czerwca 2011, 20:48:21 wysłana przez adzik »

Offline tom_21_pl

  • Wiadomości: 57
    • Zobacz profil
  • Otrzymane polubienia: 1
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #1 dnia: 27 Czerwca 2011, 17:36:05 »
Czyli maszynopedia? Coś na miarę simspedi?

Offline ShaXbee

  • Administrator
  • Wiadomości: 1984
    • Zobacz profil
  • Otrzymane polubienia: 1
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #2 dnia: 27 Czerwca 2011, 18:23:27 »
Jestem jak najbardziej ZA.

Proponuję listę artykułów z których każdy wprowadza nową wiedzę bazując na poprzednim - dzięki temu user będzie mógł szybko "przejechać się" wybranym pojazdem i stopniowo poznawać zagadnienia takie jak hamowanie, sygnalizacja, różnice w prowadzeniu pociągów towarówych i osobowych etc.

Może stworzyłbyś zarys takich dokumentów na google docs żeby osoby zainteresowane miały na bieżąco podgląd, a ewentualni autorzy mogli wprowadzać zmiany?

Offline adzik

  • Wiadomości: 58
    • Zobacz profil
  • Otrzymane polubienia: 0
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #3 dnia: 27 Czerwca 2011, 18:50:37 »
Dobrze, ale nie dzisiaj. Postaram się to jakoś w tygodniu przedstawić, gdyż w międzyczasie muszę walczyć ze "złośliwością rzeczy martwych" przy nagrywaniu zapowiedzianych i obiecanych przeze mnie tutoriali.

Czyli maszynopedia? Coś na miarę simspedi?
Tak! I jeżeli dobrze zrozumiałem, to ma wyglądać np.
  • Widok Kabiny -> Funkcje Kabiny -> Widok przedziału maszynowego -> funkcje przedziału maszynowego.
  • Ruszanie lokomotywą -> Jazda lokomotywą -> SHP i Sygnalizacja -> Hamowanie zasadnicze -> Hamowanie pomocnicze -> Zatrzymywanie lokomotywy -> Manewry -> Podłączanie wagonów -> Luzowanie składów z hamulca/hamowanie składów -> odłączanie wagonów -> zabezpieczanie lokomotywy.
  • Prowadzenie Elektrowozów -> prowadzenie spalinowozów -> Składy towarowe -> Składy osobowe -> prowadzenie EZT -> Lokomotywy manewrowe i techniki manewrów.
Gdy tylko stworzę zarys to umieszcze w temacie linka do pliku z odczytem dla wszystkich.

[EDIT]
Za podwaliny dokumentacji wezmę plik readme z Paczki Całościowej 2010_DDS, w którym dość przystępnie podane są najważniejsze informacje dotyczące symulatora, które powinny znaleźć się na stronie.
« Ostatnia zmiana: 27 Czerwca 2011, 19:02:24 wysłana przez adzik »

Offline REWIZOR

  • Administrator
  • Wiadomości: 3679
    • Zobacz profil
    • www.eu07.pl
  • Otrzymane polubienia: 10
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #4 dnia: 27 Czerwca 2011, 19:05:31 »
Przygotuj projekt, sam pomysł jest dobry. Do tej pory wiele osób opisywało swoje oczekiwania i marzenia ale jakoś nikogo chętnego do wykonania.
Pozdrawiam

Offline adzik

  • Wiadomości: 58
    • Zobacz profil
  • Otrzymane polubienia: 0
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #5 dnia: 27 Czerwca 2011, 20:47:27 »
Ok, założyłem w Google Docs kolekcję pod nazwą Dokumentacja MaSzyna, przesyłam link do spisu treści/strony tytułowej/strony startowej/nawigacji (czy jak tam inaczej to się nazwie) i proszę o ewentualne sugestię co jeszcze pominąłem na stan dzisiejszy.

https://docs.google.com/document/d/1To7KQKW9YudMfCpsGkkPUHStQagBWd8WtWl1-wLZERE/edit?hl=pl&authkey=COnviaQF
Jeszcze sprawdzę, czy mogę udostępnić i na jakich zasadach całą kolekcję, by widzieć poszczególne strony. Link dam też do pierwszego posta by nie szukać po temacie.

Offline libertyn89

  • Wiadomości: 2002
    • Zobacz profil
  • Otrzymane polubienia: 1
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #6 dnia: 27 Czerwca 2011, 21:00:56 »
brak informacji odnośnie sporządzania dokumentacji Symulatora w wersji "przystępnej dla użytkowników", tak, by zawarte tam informację odpowiadały na 90% pytań rodzących się w głowach nowicjuszy jak i średnio-zaawansowanych

Prac nie widac, ale sa prowadzone. Mam pewna koncepcje i ja realizuje, wiec odniose sie po kolei do kazdego z punktow:

Cytuj
Instalowanie i pobieranie Symulatora
Punkt sluszny, tyle ze symulatora sie nie instaluje :) Podobny punkt znajduje sie w readme PC2010 i w zasadzie tutaj zbyt wiele nie da sie zmienic/przeredagowac/uproscic.

Cytuj
Działanie startera Ra lub inaczej mówiąc Uruchamianie Symulatora/Scenerii
To rowniez jest w readme. Opis funkcji startera jest dosyc lakoniczny, mozna to poprawic. Nie jest to jednak kwestia kluczowa, gdyz to, co najwazniejsze, jest juz opisane. Zupelnie inna sprawa, to opis edytora tras. Tutaj jest olbrzymia praca do wykonania.

Cytuj
FAQ - czyli Najczęściej zadawane pytania + błędy popełniane przez nowych użytkowników
Jeden z wazniejszych elementow. Jest w readme, ale wymaga dopracowania. Caly czas pracuje (w tym celu bardzo przydalyby sie statystyki odwiedzin poszczegolnych watkow i zapytan dla wyszukiwarki, ale jakos nikt na moje pytanie w Webmasterach nie odpisal :P) nad nowa, bardziej rozbudowana wersja z podzialem na rozne kategorie tematyczne. Znajda sie tam informacje zarowno dla posiadaczy nowych jak i starych paczek.

Cytuj
Obsługa Maszyn w Symulatorze (opis funkcji + zdjęcia, działanie)
Tego w mojej koncepcji nie bylo glownie ze wzgledu na zbyt duza roznorodnosc taboru. Niemniej jednak punkt potrzebny, jesli ktos czuje sie na silach moze to zrealizowac.

Cytuj
Video Tutorial - Filmy instruktażowe
Dobry pomysl, byleby nie byly to filmy "Jak pobrac MaSzyne". Jakis poziom nalezy trzymac :)

Cytuj
Specyfikacja plików - rozpisane instrukcje i parametry - z czym co się je
To w zasadzie wlasciwa dokumentacja. Kiedys zaczalem pisac dokumentacje dla scenerii. Moznaby, a nawet trzeba to kontynuowac uzupelniajac o pliki taboru, modele i dzwieki.


Podsumowujac - pomysl adzika jest bardziej rozbudowany, niz to co na chwile obecna zostalo zrealizowane/zaprojektowane dla nowej strony. Ciekawym elementem, ktory obecnie nie byl brany pod uwage sa videotutoriale i to na nich mozna skupic uwage.
« Ostatnia zmiana: 27 Czerwca 2011, 21:13:57 wysłana przez libertyn89 »
Pozdrawiam, Karol

Offline adzik

  • Wiadomości: 58
    • Zobacz profil
  • Otrzymane polubienia: 0
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #7 dnia: 27 Czerwca 2011, 21:28:21 »
Odnośnie tutoriali... http://eu07.pl/forum/index.php/topic,18941.msg216660.html#msg216660

no i http://eu07.pl/forum/index.php/topic,18941.msg216669.html#msg216669
Cytuj
W Wolnej chwili mogę zająć się ujęciem tematu 1., 2., 3. Co do spalinowozów, to nie jestem zbyt doświadczony w ich pracy, jednak podjąć się mogę 4., 5.

@libertyn89,
Myślałem nad przeniesieniem tej właściwej dokumentacji na CMS'a MaSzyny tak, by przez WWW użytkownik mógł przeczytać to co go interesuje. Pragnąłbym informacje zawarte w readme wykorzystać (czy wręcz prawie skopiować) na wersję on-line z odwołaniami do słów-kluczy tak, by user mógł "podążać" za wątkiem coś na styl wikipedii. Z chęcią nawiąże współpracę już przy samym opisywaniu/przepisywaniu poszczególnych zagadnień na wersję WWW jednak nie mam do końca informacji na jakim oprogramowaniu przyjdzie pracować.
W moim mniemaniu, choć oczywiście mogę się mylić, strona główna powinna zawierać w sumie bieżące i aktualne dane dotyczące opisywanego aspektu, czy to będzie FAQ czy specyfikacja pliku *.SCN, a dokumenty typu readme dołączone do wydań symulatora przedstawiają informację zgodne z symulatorem (paczką) na dzień wydania.

Podobno ABu wie coś więcej na temat silnika CMS, na którym będzie śmigać strona WWW.
Przy poprzednim projekcie, stworzenie takiej dokumentacji zajeło mi 3-4 miesiące pracy, jednak z powodu różnych zgrzytów z Administracją nie ukończyłem wszystkiego. Ciekawi mnie ile czasu potrzeba będzie tutaj na skompletowanie i dodanie.

Offline libertyn89

  • Wiadomości: 2002
    • Zobacz profil
  • Otrzymane polubienia: 1
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #8 dnia: 27 Czerwca 2011, 21:36:36 »
a dokumenty typu readme dołączone do wydań symulatora przedstawiają informację zgodne z symulatorem (paczką) na dzień wydania.

Zgoda. Tym razem wyszlo nieco inaczej, bo nowa strona z dokumentacja byla w zbyt dalekiej perspektywie czasowej :)

Pragnąłbym informacje zawarte w readme wykorzystać (czy wręcz prawie skopiować) na wersję on-line z odwołaniami do słów-kluczy tak, by user mógł "podążać" za wątkiem coś na styl wikipedii.

Dobry pomysl (i tutaj po raz kolejny przydalaby sie lista najczesciej wyszukiwanych hasel z "szukajki forumowej", zeby utworzyc cos na wzor listy popularnych tagow). Do tego dodalbym zintegrowana wyszukiwarke. W znaczacym stopniu powinno to ulatwic znalezienie istotnych informacji :)
Pozdrawiam, Karol

Offline adzik

  • Wiadomości: 58
    • Zobacz profil
  • Otrzymane polubienia: 0
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #9 dnia: 27 Czerwca 2011, 22:01:42 »
Będąc zwolennikiem pracy "etapowej", poświęcając czas na stworzenie ram - planu zamierzonych działań, gdzie wychwyci się najwięcej błędów jak najtańszym kosztem, doszedłem jeszcze do wniosku, że odciążty to w dużej mierze forum, gdzie poszukiwanie tego typu informacji nie jest dość efektywne w porównaniu z proponowaną chmurą tagów kolegi @libertyna89.

Mam nadzieję na wielką współpracę z @Ra odnośnie sporządzania dokumentacji zarówno samego startera, jak i technicznej strony symulatora, czyli EXE'ka i interfejsu jakim się obecnie posługuje. Tego nam brakuje. Zastanawiam się, aczkolwiek piorytetów nie chcę na razie wyznaczać, nad stworzeniem/skompletowaniem punktu wyjścia dla początkujących modelarzy i twórców scenerii - takiego wprowadzenia - jak zacząć - w wersji odświeżonej, uaktualnionej i spisanej językiem przystępnym dla laika. (Przyznam się, że w wielu kwestiach moje pytania czasem potrafiły zaskoczyć i sprawić problem)

Offline ABu

  • Zasłużony dla Symulatora
  • Wiadomości: 492
    • Zobacz profil
  • Otrzymane polubienia: 0
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #10 dnia: 27 Czerwca 2011, 22:09:31 »
Cytuj
Podobno ABu wie coś więcej na temat silnika CMS, na którym będzie śmigać strona WWW.

Niestety, nie jestem w stanie pomóc. Ja dostarczam tylko layout, a o CMS-ie wiem tylko tyle, że jest.
ABu

Offline Bogumil.S

  • Wiadomości: 148
    • Zobacz profil
  • Otrzymane polubienia: 0
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #11 dnia: 29 Czerwca 2011, 10:54:33 »
A MediaWiki?
http://www.mediawiki.org/wiki/MediaWiki
http://pl.wikipedia.org/wiki/MediaWiki

Albo wikia...
http://pl.wikia.com/wiki/Wikia_Polska
http://pl.wikipedia.org/wiki/Wikia

Co do tej pierwszej mam jakieś doświadczenie, od strony administracji... Poza tym na forum jest temat o MediaWiki: http://eu07.pl/forum/index.php/topic,8799.0.html.
Jak widać @adzik sam się tam wypowiadałeś, czemu chcesz postawić twój projekt na nowym cms'e, a nie na MediaWiki/Wikia?

Offline ShaXbee

  • Administrator
  • Wiadomości: 1984
    • Zobacz profil
  • Otrzymane polubienia: 1
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #12 dnia: 29 Czerwca 2011, 11:43:17 »
@Bogumil - bo ma sie integrowac z reszta strony glownej, nie wspominajac o obsludze jednej aplikacji mniej. Poza tym Django wspiera różne wersje językowe strony.

Offline Bogumil.S

  • Wiadomości: 148
    • Zobacz profil
  • Otrzymane polubienia: 0
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #13 dnia: 29 Czerwca 2011, 18:54:06 »
Moja sugestia: nie wiem czy warto to na siłę integrować z resztą strony, chyba że względem wyglądu (przykład).

Offline ShaXbee

  • Administrator
  • Wiadomości: 1984
    • Zobacz profil
  • Otrzymane polubienia: 1
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #14 dnia: 30 Czerwca 2011, 14:20:50 »
Bogumil w tej kwestii decyzja zostala juz podjeta - zamiast zestawu dlango + smf + mediawiki supportujemy tylko django + smf.

Offline adzik

  • Wiadomości: 58
    • Zobacz profil
  • Otrzymane polubienia: 0
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #15 dnia: 30 Czerwca 2011, 16:04:27 »
O, to fajnie wiedzieć oficjalnie już na jaiej platformie przyjdzie nam operować. Przyznam się szczerze, że rozglądałem się trochę po Django i powoli poduczam się składni i systemu zarządzania tamtejszymi artykułami.

Offline ShaXbee

  • Administrator
  • Wiadomości: 1984
    • Zobacz profil
  • Otrzymane polubienia: 1
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #16 dnia: 30 Czerwca 2011, 17:14:44 »
Bedziemy używać tego pluginu: https://www.django-cms.org/

Edit:
Składnie narazie sobie daruj - to jest temat na później, przede wszystkim trzeba stworzyć treść :-)
Może rozdzielić poszczególne dokumenty na różnych użytkowników?

Pozdrawiam,
Zbyszek

Offline adzik

  • Wiadomości: 58
    • Zobacz profil
  • Otrzymane polubienia: 0
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #17 dnia: 30 Czerwca 2011, 19:03:39 »
Dobrze, to może zaczniemy od tego, kto będzie chciał wykonać czy zredagować artykuły.
Rozumiem, że kolega @libertyn89 nadal oferuje swoją pomoc w tworzeniu dokumentacji? Czy ktoś inny jest chętny? Można się zgłaszać tutaj, bądź na PW.
@ShaXbee - czyli chciałbyś mieć dokumentację gotową przed implementacją? Jeżeli tak, to ustalimy piorytety, rozdzielimy zadania i zasuwamy z Eaosami! :)

Offline ShaXbee

  • Administrator
  • Wiadomości: 1984
    • Zobacz profil
  • Otrzymane polubienia: 1
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #18 dnia: 30 Czerwca 2011, 19:04:21 »
No to do roboty :-)

Offline libertyn89

  • Wiadomości: 2002
    • Zobacz profil
  • Otrzymane polubienia: 1
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #19 dnia: 30 Czerwca 2011, 19:04:35 »
Rozumiem, że kolega @libertyn89 nadal oferuje swoją pomoc w tworzeniu dokumentacji?
Tak.
Pozdrawiam, Karol

Offline REWIZOR

  • Administrator
  • Wiadomości: 3679
    • Zobacz profil
    • www.eu07.pl
  • Otrzymane polubienia: 10
Odp: Dokumentacja dla użytkowników Symulatora
« Odpowiedź #20 dnia: 30 Czerwca 2011, 19:16:46 »
Libertyn89, będzie główną osobą zajmującą się nowa stroną.
Pozdrawiam