Documentation Samouczek
Rozpoczęcie pracy z dokumentacją
Szukaj…
Wersje
| Wersja | Data wydania |
|---|---|
| Prywatna beta | 26.03.2016 |
| 1 | 2016-07-25 |
| 2) | 04.08.2016 |
| 3) | 29.08.2016 |
| 4 | 2016-09-12 |
| 5 | 29.09.2016 |
| 6 | 2016-10-20 |
| 7 | 29.11.2016 |
O dokumentacji
Co można udokumentować?
- Przykłady funkcji dla różnych języków.
- Krótkie wprowadzenie każdego tagu.
Jaka jest różnica między pytaniem a tematem?
- Tematy mają szerszy zakres niż pytania; tematy dokumentacji zadawane jako pytanie można zamknąć, ponieważ są zbyt szerokie.
- Tematy powinny zawierać wiele przykładów; żądanie, które może zostać obsłużone przez jeden przykład (np. jeden blok kodu), jest prawdopodobnie zbyt wąskie.
Witaj świecie
Temat „Witaj na świecie” powinien składać się z najbardziej podstawowego, kompletnego, możliwego do uruchomienia, dostępnego programu startowego, który można osiągnąć dzięki największej liczbie dokumentowanych wersji języka, frameworku lub systemu. W razie potrzeby uwagi powinny zawierać podstawowe instrukcje dotyczące przygotowania i wykonania przykładów.
Temat na ogół nie powinien wymagać więcej niż jednego lub dwóch przykładów, z wyjątkiem przypadków, w których późniejsze wersje języka nie są kompatybilne wstecz. Pamiętaj, że temat Witaj w świecie będzie punktem wyjścia dla każdego, kto dopiero zaczyna uczyć się języka. Jako taki powinien wykazywać minimalne przykłady robocze, które uczeń może wykorzystać, aby osiągnąć poprawny program. Niekoniecznie jest to miejsce do demonstrowania najnowszych funkcji języka.