Brauche Hilfe für die Erstellung der Anleitung


#1

Das neue Release steht ja nun quasi vor der Tür und durch die neuen Features ist das alles doch ganz schön kompliziert geworden.

Das gute: ich habe geschafft alles optional zu halten. Im Grunde funktioniert alles noch so wie eh und je.

Gibt es zufällig jemanden der Erfahrung mit der Erstellung von Anleitungen zu tun hat? Notfalls setze ich mich da selber dran aber wäre schon cool wenn ich das outsourcen könnte :smiley:


#2

Hi. Der Trick bei Anleitungen ist eben, dass man Sie schreiben muss :smile: … in welchem Format soll die denn am Schluss vorliegen? Pdf, html, markdown?

Und wer ist die Zielgruppe der Anleitung?

  • diejenigen, die die Software compilieren wollen, und die Optionen verstehen?
  • diejenigen, die die Software hinterher nutzen sollen? (Also Administrator Bereich?)

Und last but not least: was ist denn die geplante deadline? Ich bin bald im Urlaub, und hätte da ggf. Zeit…

Viele Grüße
Juergen


#3

Denke Markdown wäre schön (auch wegen GitHub usw). Umfang sollte deine beiden Punkte abdecken. Weil ja auch jeder kompilieren muss etc.


#4

Hi @stephan. Ok, dann markdown. Last but not least: Doku auf Deutsch, weil die Community die größte ist… korrekt?
Viele Grüße
Juergen


#5

Ja ich denke Deutsch wäre erstmal am wichtigsten.


#6

Mein Wunsch an das Format:

  • Das wichtigste in Stichpunkten als readme.md im Github-Repository.
  • Die ausführliche Fassung für interessierte Hobbyisten dann auf der Projekt-Webseite.
  • One-Pager-PDF mit den Basics für Nutzer (ähnlich Ankus Cheatsheet).

Je nachdem wie umfangreich man hier vorgeht, könnte sich fast schon ein Dokuwiki lohnen. Dies ist IMHO jedoch wenig intuitiv zu navigieren und gerade für Erstbesucher sehr unfreundlich.

Hier wäre eine einseitige Webseite auf Tonuino.de wohl optimal. Die Community dann entsprechend unter Tonuino.de/forum bzw. Tonuino.de/community

Mein Wunsch an die Struktur

(ähnlich der noch vorhandenen Webseite https://www.voss.earth/tonuino/):

  • Projektvorstellung
    ++ Kurze (Video)-Demo
    ++ Alternativen/Marktübersicht

  • Hardware
    ++ Teileliste
    ++ benötigte Hardware / Werkzeuge
    ++ Zusammenbau
    ++ Optionales (Potentiometer, Zusatzliche Buttons etc.)

  • Software & Setup
    ++ Arduino IDE installieren und konfigurieren
    ++ Firmware laden und übertragen
    ++ SD befüllen
    ++ RFID Karten anlegen

  • Im Betrieb
    ++ Bedienung der Box
    ++ One-Pager-PDF
    ++ Karten bedrucken
    ++ Bild-Bluring-Tool

Sobald ein Inhaltsverzeichnis steht. Könnte man den Text dann in einem geteilten Google-Dok, einem Dokuwiki, oder über Github kollaborativ erstellen und anschließend in eine Webseite gießen.

Dafür interessant zu erfahren: Was @Thorsten ist dein langfristiger Plan für Aufteilung und Gestaltung der Domain Tonuino.de? Wird es hier auch eine Projektseite geben oder nur den Redirect auf diese Discourse-Instanz? Und: Hättest du die komplette Anleitung gerne in einem Wiki, auf Github oder auf der Webseite (meine Präferenz)?

Ich denke das sind Basics, die du mit deiner BDFL-Keule festlegen musst, ehe die Anleitungserstellung outgesourced wird : )


#7

Den Onepager mache ich gerne


#8

Das ist die richtige Einstellung Leute! :+1: :slight_smile:

@grimmet tonuino.de wird eine Projektseite bekommen.


#9

Hi @Thorsten, wenn Du möchtest, dann könnte ich mit der Deutschen Doku soweit anfangen. Was @grimmet schreibt mag richtig sein, dazu werde ich aber keine Zeit haben. Ich denke eine Doku, mit der man als relativer Anfänger (Arduino ist installiert, tonuino.ino Datei ist geladen) die Software auf die Hardware bekommt sollte ein guter Start sein. Die OnePager für die Eltern ist eine gute Sache, aber ich denke die Anleitung für die Kids können wir uns sparen :slight_smile: Anleitung für DAUs zu schreiben führt dann auch dazu, dass das Teil von DAUs genutzt wird, dazu braucht es aber mehr Personen, die dann helfen.
Wenn man das ganze dann anpassen möchte ist jeder eingeladen die Anleitung zu verbessern. Deshalb würde ich mit markdown anfangen. Der Rest ergibt sich dann. Wenn das für Dich ok ist, dann schick mir den neuesten Code, dann fang ich an.

Viele Grüße
Juergen


#10

Ist alles auf GitHub (auch der DEV Branch). Am besten du forkst auf GitHub und fügst die Anleitung hinzu, so kann jeder mitarbeiten bzw. den aktuellen Stand einsehen. Am Ende wird das dann per pull request in das offizielle Repo übernommen.


#11

Ein FAQ bzw. Troubleshooting sollte in der Anleitung noch enthalten sein.


#12

Ich könnte mich auch beteiligen, wenn da Bedarf besteht. Ich habe in den letzten 13 Jahren sehr viele Artikel in einem Linux-Wiki geschrieben. Einfach nur Bescheid geben. :slight_smile:


#13

Bescheid! Bescheid! Bescheid!


#14

Ich schaue mir dann einmal an wie das mit Github funktioniert und bringe mich mit ein. Bestelle mir aber noch einen weiteren Tonuino, da die anderen Geräte schon verplant sind. Sofern ich die in Beschlag nehme gibt es Ärger. :wink: