Documentation Tutorial
Erste Schritte mit der Dokumentation
Suche…
Versionen
| Ausführung | Veröffentlichungsdatum |
|---|---|
| Private Beta | 2016-03-26 |
| 1 | 2016-07-25 |
| 2 | 2016-08-04 |
| 3 | 2016-08-29 |
| 4 | 2016-09-12 |
| 5 | 2016-09-29 |
| 6 | 2016-10-20 |
| 7 | 2016-11-29 |
Über die Dokumentation
Was kann dokumentiert werden?
- Beispiele für Funktionen für verschiedene Sprachen.
- Eine kurze Einführung zu jedem Tag.
Was ist der Unterschied zwischen einer Frage und einem Thema?
- Themen sind breiter als Fragen; Dokumentationsthemen, die als Frage gestellt werden, können geschlossen werden, da sie zu umfangreich sind.
- Themen sollten mehrere Beispiele haben; Eine Anfrage, die von einem Thema mit einem einzigen Beispiel (z. B. einem Codeblock) bearbeitet werden kann, ist wahrscheinlich zu eng.
Hallo Welt
Ein Hallo-Welt-Thema sollte aus dem grundlegendsten, vollständigsten und lauffähigsten Starterprogramm bestehen, das durch die größte Anzahl von Versionen der zu dokumentierenden Sprache, des Frameworks oder des Systems erreicht werden kann. Bei Bedarf sollten die Anmerkungen grundlegende Anweisungen zur Vorbereitung und Ausführung der Beispiele enthalten.
Das Thema sollte im Allgemeinen nicht mehr als ein oder zwei Beispiele erfordern, außer in Fällen, in denen spätere Versionen der Sprache nicht abwärtskompatibel sind. Denken Sie daran, dass das Thema "Hallo Welt" der Ausgangspunkt für alle ist, die gerade erst anfangen, eine Sprache zu lernen. Als solches sollte ein Minimum an Arbeitsbeispielen gezeigt werden, die ein Lernender verwenden kann, um ein korrektes Programm zu erreichen. Es ist nicht unbedingt ein Ort, um die neuesten Funktionen einer Sprache zu demonstrieren.