Tutorial, E-Book und andere Publikationsformen
-
http://www.oreillymaker.com/link/28885/prettyos/ <--- echt lesenswert, leider noch nicht geschrieben.
-
Da sich inzwischen einiges gegenüber dem Stand in Teil 3 des Tutorials geändert hat, stellt sich die Frage der Dokumentation und des Quickguides für den Einstieg erneut.
-
Erhard Henkes schrieb:
Das Format gefällt mir. Ich würde nur gerne bezüglich des Inhalts an manchen Stellen etwas ergänzen (z.B. Hinweise bezüglich Tools). :xmas2:
Welche Infos/ Inhalte möchtest Du drinn haben?
Erhard Henkes schrieb:
http://www.oreillymaker.com/link/28885/prettyos/ <--- echt lesenswert, leider noch nicht geschrieben.
Immer langsamm... Ich arbeite ja schon drann ^^
Erhard Henkes schrieb:
Da sich inzwischen einiges gegenüber dem Stand in Teil 3 des Tutorials geändert hat, stellt sich die Frage der Dokumentation und des Quickguides für den Einstieg erneut.
Ich finde, man sollte evtl. noch ein 4. Teil schreiben... Am Ende des Tutorials sind noch viele fragen offen... Wobei wir gerade dabei sind: Ergänze mal das komplette Tutorial um die Angaben der Dateinamen, wo welcher Quelltext hinein gehört
---
Ich habe am Ebook weiter gemacht. Im RM Teil bin ich nun im Bereich "Erster Start des ebend erstellten Betriebssystems". Die neueren Dateien sind bereits oben. Und, die Bereiche, die ich übersprungen habe, sind weiterhin leer. Dazu kann ja mal jemand etwas schreiben
-
Ähm
Möchtest du vllt ein bisschen Webspace bei mir haben? Ich find die Werbung bei Funpic nicht gerade... praktisch^^
Cuervo
-
Cuervo schrieb:
Ähm
Möchtest du vllt ein bisschen Webspace bei mir haben? Ich find die Werbung bei Funpic nicht gerade... praktisch^^
Cuervo
Das ganze ist nur eine Testumgebung. Sobald das Ebook fertig ist, kommt es auf einen meiner Webspace Pätze. Aber, danke für Dein Angebot
-
Ok, aber dann möchte ich, dass du da noch etwas einfügst, alle anderen hast du auch drin (!!!):
http://henkessoft.de/OS_Dev/OS_Dev1.htm
Dann gibt es da noch viele andere, z.B. Christian F. Coors, der mich auf einen Fehler (RAM Disk Speicherbelegung) aufmerksam machte und mich auch sonst bei der Fehlersuche und umfangreichen Tests kräftig unterstützt.
(fehlt in http://rmweb.rm.funpic.de/PrettyOS_Dokumentation/einfuehrung.html)
-
Cuervo schrieb:
Ok, aber dann möchte ich, dass du da noch etwas einfügst, alle anderen hast du auch drin (!!!):
http://henkessoft.de/OS_Dev/OS_Dev1.htm
Dann gibt es da noch viele andere, z.B. Christian F. Coors, der mich auf einen Fehler (RAM Disk Speicherbelegung) aufmerksam machte und mich auch sonst bei der Fehlersuche und umfangreichen Tests kräftig unterstützt.
(fehlt in http://rmweb.rm.funpic.de/PrettyOS_Dokumentation/einfuehrung.html)
Da hätte ich von Dr. Henkes gerne mal eine Liste derjenigen, die mitgewírkt haben...
-
Inzwischen sind das einige mehr. Ich kuemmere mich naechste Woche um ein Update.
-
Erhard Henkes schrieb:
Inzwischen sind das einige mehr. Ich kuemmere mich naechste Woche um ein Update.
Wie ist der aktuelle Stand? Hast Du auch die Angabe der Dateien, in die der jeweilige Quelltext rein gehört, mit eingesetzt?
-
Die Datei findet man doch im Download. Ansonsten machen im Moment Badestrand, Cuervo und abc.w mit. _fricky hat uns einen USB-Treiber versprochen und bisher nichts gezeigt, ist seitdem verschwunden. Ansonsten gibt es einige wichtige Ratgeber, z.B. XanClic und Tobiking. That's it.
-
Erhard Henkes schrieb:
Die Datei findet man doch im Download.
Auf der ersten Seite Deines Tutorials sollte den Leser schon sagen, was wo hin gehört... Im 2. Abschnitt kann man ja auf die Beispieldateien verweisen... Und, was mir besonders auffiel: Die angehängten Beispiele unterschieden sich teilweise erheblich von dem, was man im Tutorial las... Wenn man Beispiele beilegt, sollten diese Deckungsgleich zum Tutorial sein und nicht schon teile des folgenden Abschnittes beinhalten...
Erhard Henkes schrieb:
Ansonsten machen im Moment Badestrand, Cuervo und abc.w mit. _fricky hat uns einen USB-Treiber versprochen und bisher nichts gezeigt, ist seitdem verschwunden. Ansonsten gibt es einige wichtige Ratgeber, z.B. XanClic und Tobiking. That's it.
Das setze ich dann mal ins E-Book ein.
-
Wenn man Beispiele beilegt, sollten diese Deckungsgleich zum Tutorial sein und nicht schon teile des folgenden Abschnittes beinhalten...
Ja, da gab es ab und zu kleine Feinheiten.
-
Aufgrund der letzten Ereignisse im Forum stelle ich hier mal folgende Frage:
Soll PrettyOS weiter Dokumentiert werden, oder soll man ein (neues) OS parallel zu PrettyOS erstellen und es Dokumentation
-
Ich denke, wir sollten PrettyOS bis zu einem gewissen Stand - nennen wir ihn mal 1.0 - stabilisieren. Folgende Möglichkeiten stelle ich mir dabei vor:
- Dokumentation nach innen in den Quellcode legen (evtl. automatisch extrahierbar)
- Ein Tutorial (z.B. Teil 4 im Internet) oder ein E-Book (von mehreren Autoren, kostenlos oder gegen paypal, je nach Aufwand) erstellen, das zu diesem Status 1.0 von Null an führt: was ist ein OS? warum OSDEV? welche Tools? PrettyOS erstellen. Mit PrettyOS experimentieren (mir als Chemiker sehr wichtig ).
- Eine Weiterentwicklung von PrettyOS, die zunächst wie unter 1 im Code dokumentiert wird.
Wir brauchen hier also eine funktionierende "Schleife".
Vielleicht hat jemand eine bessere Idee.
-
PrettyOS erstmal zu einem gewissen Stand bringen und dann das Tutorial dazu schreiben klingt auf jeden Fall besser als in dem Tutorial mehrmals an der gleichen Stelle herumzudoktern weil einem später etwas auffällt das geändert werden muss. Bevor man zu einem Teil ein Tutorial schreibt sollte man diesen auch verstanden haben.
Inwiefern die Dokumentation im Quellcode Sinn macht muss man gucken. Eine Beschreibung (im Doxygen Stil) darüber was eine Funktion macht und kleinere Kommentare an verzwickten Stellen passen sicherlich in den Quellcode. Die genaue Funktionsweise und eine Erklärung zu der Funktion sollte dann aber doch schon extern sein.
-
Hier kann ich Tobiking nur zustimmen.
-
Hallo,
Gamepower schrieb:
Soll PrettyOS weiter Dokumentiert werden, oder soll man ein (neues) OS parallel zu PrettyOS erstellen und es Dokumentation
Ich würde eher sagen das Ihr den Weg zu einem ordentlichen OS dokumentieren solltet. Das währe eine echte Bereicherung des deutschen Internets.
Tobiking2 schrieb:
PrettyOS erstmal zu einem gewissen Stand bringen und dann das Tutorial dazu schreiben
Dann fehlen aber wieder die ganzen Designentscheidungen (entschuldigt bitte das ich auf diesem Wort so rumreite aber einfach eine gewisse Menge an Problemlösungen hintereinander zu klatschen ohne die Problemursachen zu beschreiben find ich einfach doof, davon gibt es schon zu viel im Internet, http://www.brokenthorn.com/Resources/OSDevIndex.html scheint auch in diese Kategorie zu fallen). Gerade der Weg der zu einem bestimmten Ziel führt ist doch wichtig. Sonst ist der Leser nur in der Lage genau Euer OS ein weiteres mal zu schreiben (entwickeln währe schon das falsche Wort) und nicht was neues/eigenes zu erschaffen.
Tobiking2 schrieb:
Bevor man zu einem Teil ein Tutorial schreibt sollte man diesen auch verstanden haben.
Das ist wohl war, aber man kann/sollte während des Verstehens ein paar Notizen machen damit man dann auch wirklich beschreiben kann warum die Probleme so gelöst wurden wie sie gelöst wurden.
Tobiking2 schrieb:
Inwiefern die Dokumentation im Quellcode Sinn macht muss man gucken. Eine Beschreibung (im Doxygen Stil) darüber was eine Funktion macht und kleinere Kommentare an verzwickten Stellen passen sicherlich in den Quellcode. Die genaue Funktionsweise und eine Erklärung zu der Funktion sollte dann aber doch schon extern sein.
ACK. Das "Wie" gehört in den Quell-Code, das "Warum" in ein ordentliches Text-Dokument. Querverweise währen eine zusätzliche Bereicherung, wenn im Quell-Code an einer verzwickten Stelle steht "siehe Kapitel X" dann könnte der Leser dort in Langform nachlesen welche Designentscheidung eben zu genau dieser Lösung geführt hat und verstehen was dahinter steckt.
Grüße
Erik
-
"währe" ist falsch (Standardfehler bei Dir), kommt nicht von "wahr", sondern ist der Konjunktiv von "war".
-
Hallo,
Erhard Henkes schrieb:
"währe" ist falsch ...
Wenn das alles ist was Dir zu meinem Beitrag einfällt dann bin ich hier eindeutig fehl am Platz!
(Womit ich nicht sagen will das korrekte Orthographie ganz zu vernachlässigen ist.)Grüße
Erik
-
Du stellst das Thema Designentscheidungen in den Vordergrund, ist auch ok, wird zukünftig stärker berücksichtigt. Dein Impetus ist also akzeptiert.