15.2.2009 16:24
|🇵🇸 | skóre: 93
| blog:
Přehled odkazů na dokumentaci
Přečteno: 502×
Portál AbcLinuxu, 21. listopadu 2025 04:31
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?
Řešení dotazu:
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?
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.
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.
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:
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).
Bezva, rad poradim pri implementaci.
Tiskni
Sdílej:
ISSN 1214-1267, (c) 1999-2007 Stickfish s.r.o.
16.2.2009 17:23