Diskussion Struktur der Anleitungen
Verfasst: Sa 31. Dez 2016, 12:11
Wie bei den "Ankündigungen" bereits publiziert gibt es momentan zwei Anleitungen für den Anwender des i-Telex-Systems.
Es gibt noch einiges zu tun in diesem Zusammenhang, unter anderem eine "Einsteiger"-Anleitung die sich an technisch weniger versierte richtet sowie eine Aktualisierung der Anleitungen (eher Handbuch) auf den neuesten Entwicklungsstand.
Zu letzerem frage ich mich derzeit, wie eine "gutes" Handbuch aussieht... Zu jeder Platine bzw. zu jedem Modul ein eigenes Dokument oder alles zusammen in einem "dicken" Buch?
Letzteres vermeidet Doppelungen, hat aber den Nachteil dass ein Anwender ggf. "Ballast" dabei hat (Beispielsweise die Beschreibung einer Doppelstrom-Schnittstelle) der gar nicht interessant ist.
Eure Meinung?
Hilfe ist natürlich auch immer willkommen, insbesondere auch Hinsichtlich Übersetzung ins Englische.
Es gibt noch einiges zu tun in diesem Zusammenhang, unter anderem eine "Einsteiger"-Anleitung die sich an technisch weniger versierte richtet sowie eine Aktualisierung der Anleitungen (eher Handbuch) auf den neuesten Entwicklungsstand.
Zu letzerem frage ich mich derzeit, wie eine "gutes" Handbuch aussieht... Zu jeder Platine bzw. zu jedem Modul ein eigenes Dokument oder alles zusammen in einem "dicken" Buch?
Letzteres vermeidet Doppelungen, hat aber den Nachteil dass ein Anwender ggf. "Ballast" dabei hat (Beispielsweise die Beschreibung einer Doppelstrom-Schnittstelle) der gar nicht interessant ist.
Eure Meinung?
Hilfe ist natürlich auch immer willkommen, insbesondere auch Hinsichtlich Übersetzung ins Englische.