Dotaz: Přehled odkazů na dokumentaci

[|🇵🇸]

Na základě diskuse o dokumentacích mne napadlo, že by bylo fajn, kdyby tady existovala nějaká wiki stránka (respektive sekce á la Software), na níž by byl přehled různých (open-source nebo linuxových ^_^) knihoven/API s odkazy na tutoriály, dokumentaci a s velice krátkým popiskem.

Představoval bych si to jako rozbalovací strom sekcí jako rozcestník v sekci Software a v každé sekci by byla tabulka (tedy ne zvláštní podstránky):

knihovna X    odkaz na web    odkaz na dokumentaci    odkaz na tutoriál
    stručný popis
knihovna Y    odkaz na web    odkaz na dokumentaci    odkaz na tutoriál
    stručný popis
knihovna Z    odkaz na web    odkaz na dokumentaci    odkaz na tutoriál
    stručný popis

Má to vůbec smysl? Pokud ano, kam s tím? Do nějaké skupiny?

---

---

Odpovědi

[|🇵🇸]

Ještě k tomu, k čemu by to bylo dobré: Pokud by někdo zjišťoval, co použít za knihovnu (respektive co za knihovny k danému tématu vůbec existuje), měl by docela dobrý výchozí bod.

[Josef Kufner]

Raději bych pro každou knihovnu vlastní stránku. A při implementaci takovéhoto základu už počítat s dalším krokem ve vývoji -- s robotem (crawlerem) a vyhledáváním napříč veškerou dokumentací a společnou navigací po různých dokumentacích.

Takže odkazů na jednu dokumentaci by mohlo být více: hlavní (úvodní) stránka, obsah, rejstřík, offline verze,... U tutoriálů, které vyšly jako články, by se hodily odkazy na jednotlivé díly.

A není potřeba tohle moc komplikovat, stačí ke každému odkazu dát příznak, na co vede. Tím bude umožněno s tím v budoucu nějak naložit a nyní tam třeba dát ikonku

[|🇵🇸]

Takže stačí současná sekce Software...?

[Josef Kufner]

Ne tak docela. Mohlo by to být velmi podobné, ale bylo by potřeba o entitu více.

Sekce Software má nějaký "Program" a k tomu má pár "odkazů". U dokumentace by bylo potřeba mít "Knihovnu" k ní mít "Dokumentaci" a k tomu teprve těch pár "odkazů".

[Leoš Literák]

Jde tedy o rozcestnik po dokumentaci, ne mirror? A ma to byt jen pro API nebo cokoliv? Co treba dokumentace pro mysql, openoffice, firefox? Ma to mit RSS?

[|🇵🇸]

Já myslím rozcestník po dokumentacích k programování, kolega myslí +/- mirror. ^_^

[Josef Kufner]

Primárně to má být rozcestník, ale jakmile se v tom má vyhledávat, tak se to stáhnout a proindexovat musí. Takže mirror asi tak jako google cache.

RSS, pokud bude mít smysl Vlastně jediné, co se tam může nějak měnit je, že některý z odkazů přestane fungovat a robot někomu pošle mail, ať na to koukne...

Téma dokumentace by asi mělo být hlavně programovací, ale v podstatě je to jedno.

[Leoš Literák]

Rozcestník klidně, ale indexovat cizí dokumentaci? Do toho bych se raději nepouštěl, to je velký cíl. A těžko říci, zda bychom přinesli něco navíc, kvůli čemu by návštěvníci chodili k nám a ne na domovské stránky či google.

[Josef Kufner]

Zas tak veliký není

Ono se to celé dá naštěstí rozdělit na několik kroků, kde i samotný rozcestník bude užitečný. Jen je potřeba mít na paměti možný budoucí vývoj a zajistit, že budou později dostupná všechna nutná metadata i za cenu, že ze začátku nebudou mít žádný přínos (např. odkaz na rejstřík).

Jinak mám celkem jasnou představu, jak by takové vyhledávání mohlo fungovat a oproti googlu by mělo kvalitnější zdroj dat. Podívej se např. na tyhle tři odkazy:

• http://library.gnome.org/devel/glib/stable/ix01.html
• http://www.php.net/manual/en/indexes.php
• http://doc.trolltech.com/4.4/functions.html

Formát dokumentace naprosto odlišný, ale pouhým vycucnutím odkazů (resp. tagů li+a) z této jedné stránky máš postačující data k použitelnému vyhledávání v celé dokumentaci. To by mohl být druhý krok po rozcestníku.

Navíc pak není problém odkazovanou dokumentaci zavřít do framu a vyrobit tak lištu s vyhledávacím políčkem a navigací z abclinuxu.

Třetím krokem by mohl být crawler a fulltext jako doplněk k vyhledávání v názvech funkcí z druhého kroku. A s tím související mirrorování dokumentace.

Ale jak už jsem psal, stačí dojít k libovolnému z těchto kroků a bude to použitelný a užitečný produkt.

Btw, teď mě čeká předmět zvaný „Programování v jazyce Java“ a asi budu hledat téma na semestrálku, takže možná bych vrámci toho mohl napsat nějaký prototyp vyhledávání v názvech funkcí vytažených z rejstříku (tj. druhý krok).

[Leoš Literák]

Bezva, rad poradim pri implementaci.

[Josef Kufner]

Bugzilla: http://bugzilla.abclinuxu.cz/show_bug.cgi?id=1235