Dokumentace seřazená abecedně

Dokumentace by měla aktuálně být seřazena tak jak by to dává logicky smysl a jako by se měl postupně nette učit nováček.

Patrik Votoček napsal(a):

Dokumentace by měla aktuálně být seřazena tak jak by to dává logicky smysl a jako by se měl postupně nette učit nováček.

Nebo alespoň tam přidat možnost řazení, třeba logické a abecední.

Mně by úplně stačilo, kdyb se zrušil ten hover efekt nad metodami v API, a fungovalo to na click, takhle mi API poskakuje, a kolikrát zjistím, že jsem kliknul na jinou metodu, než jsem měl původně v úmyslu…

Editoval 22 (30. 8. 2012 23:32)

Jo, fakt :-) dobré…

Souhlas + bych přejmenoval „Zpracování obrázků“ na jen „Obrázky“ a „Odesílání emailů“ na jen „Emaily“, když totiž po delší době něco hledám, hledám jen ten výraz (emaily, obrázky).

Souhlas. Prejmenovat „Prace s necim“ na „Neco“. Potom bude i to razeni o neco smysluplnejsi. :)

Soucasne poradi je totalne k nicemu. Nema zadnou logiku. V cem je napriklad databaze mene dulezita nez Http request & response. Pro novacka uplne v haji. Pro cloveka ctouci dokumentaci je nedohladatelne.

@Jan Tvrdík: Zde jsou abecedně pouze slugy z url, nikoliv titulky, což je dost matoucí, byť asi logičtější.

Editoval HosipLan (31. 8. 2012 18:24)

Já jsem vždycky nejvíce nadával, když jsem hledal odkaz na API. Pak mne napadlo si ho přidat do toolbaru prohlížeče a od té doby to že se ztrácí mezi ostatními odkazy neřeším :-)

@Grelek, @Caine +1

robim s nette uz par rokov a stale hladam, co potrebujem, abecedne poradie by sa hodilo. minule som hladal obrazky trvalo mi dobrych 5 minut kym som nasiel, ze je to Zpracování obrázků.

bazo wrote: minule som hladal obrazky trvalo mi dobrych 5 minut kym som nasiel, ze je to Zpracování obrázků.

Myslím, že je pomalu čas, naučit se používat svůj webový prohlížeč a internet obecně – považuji totiž za normální používat hledání jak na stránce (Ctrl+F v prohlížeči) tak pomocí Google.

Prohlížeč to bude mít vždy najité dřív jak ty.

Myslím, že je pomalu čas, naučit se používat svůj webový prohlížeč a internet obecně – považuji totiž za normální používat hledání jak na stránce (Ctrl+F v prohlížeči) tak pomocí Google.

Já si myslím, že je začít třeba používat logiku.

• vyhledávní na stránce: prohlížeče IE, Firefox, Opera neumí vyhledet bez diakritiky
• vyhledání googlem: dokumentace je v strasnym bordel stavu
  • polovina dulezitych veci je v plannete
  • duplicitni verze v aj / en
  • chyby ve smerovani (tuhle sem chtel najit coding aktualni coding standards… schvalne zkuste)

Koment o vyhledavani je mimo. Stale neznam duvod aktualniho poradi. Vymyslelo se to nekdy kolem verze 0.8, kdy byl framework uplne jinde (a list byl mnohem prehlednejsi diky subsekcim). Nazvy jednotlivych odkazu jsou spatne. Odkdy ma nette ORM? Ta uvodni stranka dokumentace je opravdu WTF a rada, ze mas pouzivat svuj vyhledavac urcite velmi potesi vsechny nove uzivatele frameworku, hlavne ty v zahranici.

@redhead má asi pravdu s tím, že nutnost používat CTRL+F na stránce zavání špatnou použitelností.

Hlavním „problémem“ je, že nette.org je především obsahový web. Kdy jste se naposledy k nějakému článku na wikipedii proklikali z hlavní stránky? To je přece hovadnina. Když použiju vyhledávání, budu tam minimálně o řád rychleji i než autor webu.

Zase je ale potřeba uznat, že malé postrčení ve formě účelného seřazení témat na hlavní stránce dokumentace může pár začátečník pomoct rozhodnout se, co si přečtou nejdřív.

A nebo taky ne. Přijde mi, že to, že někdo studuje dokumentaci od začátku do konce, je spíše velice výjimečný stav.

@hrach: je dost hloupý argument, že to prohlížeče neumí, protože můj to umí.

Raději to ale ještě jednou shrnu: je mi jedno jak si to seřadíte, já si budu používat vyhledávání a budu tam vždycky rychleji než vy :)

Editoval HosipLan (2. 9. 2012 11:54)

@Jan Tvrdík

Ok, zkusil jsem.

Koukam, ze te je lehke uspokojit. Jestli tobe staci prvni vysledek vyhledavani, ktery je nahore oznacen jako being revised a pouze v en… To je podle me nedostatene. Osobne me po nalezeni teto stranky hnala snaha, zda a) je novejsi verze b) zda je ceska verze. Tím sem prisel na to, ze stranka navic neni ani zarazena v en dokumentaci. https://doc.nette.org/…ibuting/code (proklik z doc.nette.org).

Jsi naprosto mimo. Opíráš se o historické skutečnosti, které zřejmě neznáš. Současné pořadí odkazů je (pokud vím) práce Davida Grudla a je navržené pro Nette 2.0 stable.

Tak predne se opiram o zkusenosti. Pokud srovnam doc 0.9 tak tam vidim uplne stejne razeni, akorat se do 2.0 droply subsekce. Kolik let ze trval vývoj 2.0? Tzn. kolik let je to stary navrch razeni? 3 roky vcetně trvani devitky, za tu dobu se zmenilo imo dost.

chyby ve smerovani

Co tím myslíš?

Pokud neexistuje stranka v danem jazyce, neda se prepnout na jinou jazykovou verzi. Clovek se musi vratit na predchozi stranu, tam prepnout jazykovou verzi a doufat, ze odkaz na stejne tema je tam taky.

@HosipLan
Vsak ja netvrdim, ze optimalizovanost pro vyhledavani je spatna. Ja jen souhlasim s nazorem, ze aktualni UI doc stranky je naprosto spatne. A na tento argument tu existuji jenom reakce typu, ze neumim pouzivat vyhledavac. Vyhledavani je dobre pouzit tehdy, kdyz vis co presne hledas.

Jan Tvrdík napsal(a):

bazo wrote: minule som hladal obrazky trvalo mi dobrych 5 minut kym som nasiel, ze je to Zpracování obrázků.

Myslím, že je pomalu čas, naučit se používat svůj webový prohlížeč a internet obecně – považuji totiž za normální používat hledání jak na stránce (Ctrl+F v prohlížeči) tak pomocí Google.

a inak si v poriadku? hladam ocami, ako kazdy normalny clovek. myslim, ze je pomaly cas, prestat predpokladat, ze vsetci su ako ty

co záleží na tom jaký byl historický vývoj, když je to blbě právě teď?

řazení je založeno na pocitu, že by to možná mohlo někomu pomoci, i když už je tu několik lidí, kterým to zcela objektivně nepomáhá, ale vadí

Dokumentaci se nikdo neuci tak, ze jeden den sedne a projde to vsechno podle doporuceneho poradi.

Já se tak naučil Nette, Doctrine atd. ;) asi výjimka

Šlo by to co píše vvoody … anebo to mít možnost přepnout, jako nastavení řazení na http://diskuse.jakpsatweb.cz/ s tím, že je otázka, co by bylo defaultně. Ale pokud by to tlačítko bylo jasné a viditelné, tak by na tom tolik nezáleželo.

Určitě je pravda, že abecedně se hledá líp, zejména těm, co za součacným řazením žádný vyšší princip nevidí, takže +1 pro abecední seřazení.

Editoval 22 (3. 9. 2012 21:09)

Demokracie nefunguje :) A hlavně v Nette ne. Prostě budou padat argumenty tak dlouho, dokud David nerozhodne ;)

HosipLan napsal(a):

Prostě budou padat argumenty tak dlouho, dokud David nerozhodne ;)

no tak už aby začaly padat. ze strany vyššího principu zatím nic :P

Nemůžu si pomoct, ale cca 10 lidí chce abecední řazení a 2–3 ne..
Ještě bych se zeptal, kdo z těch, co nechtěj abecední řazení, tu dokumentaci skutečně využívá?:)

A co tam dát obě varianty a podle (bool) rand(0, 1) náhodně rozhodnout, jak se to zrovna vypíše? Uspokojí a naštve to oba tábory stejně. 

Ale teď vážně – aktuální řazení mi dává smysl, je to imho seřazené zhruba dle priority. Nicméně požadavek na abecední řazení taky chápu, pokud hledám něco konkrétního. Co tam dát podobnou funkci, jako má ApiGen:

Tj. přepnutí mezi přirozeným a abecedním řazením?