Nowa dokumentacja symulatora

[ShaXbee]

Zapraszam do udziału w dyskusji nad formą i treścią dokumentacji.

Jaka powinna być? Co zawierać?

[hejnal]

Więcej informacji dla modelarzy. Chodzi mi o wytyczne itp.

[ShaXbee]

Oto moje propozycje:

Dokumentacja powinna być podzielona na logiczne części:

  - szybki start: czyli co należy wcisnąć aby uruchomić lokomotywę bez znajomości technikaliów, proponuję formę podobną do poradnik Jak Ruszyć Lokomotywą autorstwa Iwana.

  - budowa i dzialanie lokomotyw (elektrycznej i spalinowej): czyli krok po kroku opisane co do czego służy w lokomotywie. Najlepiej w konwencji od ogółu do szczegółu.

  - przepisy: czyli co oznaczają znaki, semafory, jakich zasad należy się trzymać przy prowadzeniu lokomotywy itp.

  - prowadzenie lokomotywy: czyli praktyczne zastosowanie poprzednich 2 działów, ta część musi być znacznie szersza od "szybkiego startu"

  - słowniczek: tu chyba nic nie trzeba tłumaczyć

[ABu]

Może nam wyjść z tego niezła książka :)
Ja proponuję na tyle uelastycznić projekt tej dokumentacji, żeby
przesiadka na Nebulę w zasadzie nie wymagała żadnych zmian.

W rozdziałach pt. 'Budowa i działanie' oraz 'Przepisy' zmieniać nie
będzie trzeba nic lub prawie nic, w pozostałych rozdziałach
będzie trzeba zmienić prawdopodobnie tylko nazwy klawiszy
odpowiedzialnych za poszczególne opcje. Tak więc za w/w
rozdziały można się zabierać 'od zaraz' :)

Pozdrawiam
ABu

[mw158979]

Więcej informacji dla modelarzy. Chodzi mi o wytyczne itp.

W dokumentacji - tak. Ale na razie okazalo sie, ze to ma raczej byc instrukcja.


Co do formy to dam propozycje, jaka mi pierwsza przyszla na mysl: HTML.

Zalety:
- mozliwosc umieszczenia w sposob naturalny na stronie projektu
- mozliwosc czytania off-line, na wielu systemach
- latwosc tworzenia
- mozliwosc wstawiania obrazkow, np z kabina ET22 :-]
- latwosc poruszania sie przy dobrze zrobionym systemie odnosnikow, np do definicji w slowniczku, do opisu wskaznika w przepisach itp

[ABu]

Ja bym to natomiast widział jako .pdf, w formie bardzo
przypominającej podręcznik (ewentualnie obydwie formy
pdf+html na raz - mogę zająć się składem tekstu). Nie
wiem jak Wy, ale ja bardzo nie lubię się uczyć z ekranu.

Korzyść z tego taka, że można sobie to wydrukować
i poczytać gdziekolwiek, choćby w pociągu... Można też
czytać w trakcie zabawy symkiem, bez konieczności
stosowania 'alt + tab'. A porządnie złożony tekst po
wydrukowaniu moim zdaniem ładniej wygląda niż html.

Dodatkowo do tej instrukcji można by dodać jako dodatek
wzory druków stosowanych na kolei, np. opracowane przez
CTLa 'karty pracy'.

Pozdrawiam

[Nicolass]

Faktyczmie PDF jest dużo lepszy jeżeli chodzi o drukowanie, choć HTML bije PDF jeżeli chodzi o czytanie dokumentacji z ekranu. Warto by ową dokumentację dołączać do oficjalnych wersji (ja preferuje wersje Full i Light  symka, ta pierwsza z ciekawym intro, dokumentacją, wszelkimi dodatkami pozbawionymi błędów, i innymi bajerami, tą drugą bez żadnych dodatkowych bajerów czyli goły symek). Jeżeli chodzi o wersje symka na Nebule, proponuje wprowadzić numerki wersji (1.0; 2.0; 3.15 itp) tak jak numeruje swoje wersje programu twórca Jet'a ( http://af186.internetdsl.tpnet.pl/doman/jet/download/index.html ).