Co Vám vadí na dokumentaci?

Upozornění: Tohle vlákno je hodně staré a informace nemusí být platné pro současné Nette.
před 10 lety
Filip Klimeš
Nette Blogger | 156
+
+17
-

Za dobu co se pohybuji okolo Nette jsem si vyslechl poměrně dost stížností na dokumentaci. Rozhořčené komentáře ovšem nic nevyřeší, tak jsem se rozhodl posílat raději pull-requesty. A ono to funguje!

Protože já už framework poměrně dobře znám, dokumentaci už moc nepročítám. Nicméně, určitě se mezi vámi najde někdo, kdo v ní narazil na problém. A tak se ptám – co Vám vadí na dokumentaci?

P.S.: Pokládám otázku, aby se mi nejlepší odpovědi neztratily. Pokud někdo již přidal podobný problém jako máte vy, jednoduše mu dejte palec nahoru a tím jeho odpověď posunete.

před 10 lety
Ot@s
Backer | 476
+
+5
-
  1. Roztříštěnost. Něco je v dokumentaci, něco na planette, něco ve fóru, něco na phpfashion…
  2. Kill feature nejsou velmi často zdokumentovány (nejčastěji vyplavou ve fóru).
  3. Komplexnější/aktuálnější best practise na planette.

Otázku CZ/EN neřeším.

před 10 lety
Pavel Kravčík
Člen | 1196
+
-2
-
  1. Často spíš mate, než pomáhá. Například je tam uvedena funkce s dvěma parametry. V API má 3.
  2. Quick start má asi 3 chyby jestli si dobře vzpomínám. Pak je to potřeba googlit a člověk v tom má guláš.
  3. Nemůžu jí editovat bez .Git
  4. Některé věci jsou psané hodně, hodně obecně a užitečné se stanou až třeba po 3 měsících i přestože jsou to základy FW.
před 10 lety
Mysteria
Člen | 797
+
0
-

1. Pokud je ten třetí volitelný, tak bys ho tam i tak radši viděl s defaultní hodnotou?

před 10 lety
Pavel Kravčík
Člen | 1196
+
0
-

1. Je to hodně subjektivní. Ale určitě bych ho tam rád viděl. Třeba, když jsem začínal s Nette – vůbec jsem neměl šajnu, co která funkce má dělat. Hledal jsem, jak řešit multiupload → dokumentace uvádí 2 parametry. API 3. A ten třetí musí být TRUE, když chci správné chování formuláře.

Takže jsem vyzkoušel 2 extension, přečetl 3 verze dokumentace, založil téma ve fóru a pak to našel kolega na phpfashion. Takže zabitý třeba 3 hodiny jedním parametrem, který chyběl v dokumentaci. Protože jsem předpokládal – dokumentace = API. Prostě nikdy mě nenapadne hledat v API, když tu funkci vidím popsanou v dokumentaci. :)

před 10 lety
David Grudl
Nette Core | 8228
+
+6
-

Loni jsem to sepisoval https://forum.nette.org/…-dokumentaci.

(Update: text jsem zaktualizoval, vyřešené věci jsou škrtnuté.)

před 10 lety
Filip Klimeš
Nette Blogger | 156
+
0
-

Okay, nenapadlo mě se podívat do uzavřeného fóra, moje blbost.
Koukám, že mám pořád dost prostoru se vyšplhat v contributors listu na GitHubu na přední pozice ;)

před 10 lety
David Matějka
Moderator | 6445
+
0
-

2. a nahlasil jsi je?
3. kdyz otevres nejaky soubor, tak nahore je ikonka tuzky – pak to muzes editovat primo v github editoru a poslat PR.
4. konkretnejsi bys nebyl?