ARCHIV

Pravidla pro vkládání skriptů

Protože soutěž ve vkládání skriptů za měsíc červenec vstoupila do své poloviny a počet skriptů atakuje stovku, je vhodné ozřejmit pravidla vkládání.

15.7.2004 17:00 | Petr Hatina | Články autora | přečteno 5494×

Protože jsem nově dostal na starost kontrolu a schvalování vkládaných skriptů, chtěl bych zde zdůraznit pravidla pro vkládání, která mají jediný cíl, aby kvalita převážila nad kvantitou.

Především bych chtěl poděkovat za široký ohlas a velký počet zaslaných příspěvků.

Závazná pravidla pro vkládání skriptů

1. Zkontrolujte si předem funkčnost skriptu na svém počítači. Skripty zkoušíme a nefunkční vracíme.
2. V některých případech je nefunkčnost způsobena chybějícími soubory na které se skript odkazuje. ( chybějící inline soubory, obrázky, zvukové soubory, nefunkční odkazy). Čili i to si zkontrolujte a nějak opravte. Pokud by jste opravdu chtěli vložit skript, který vyžaduje jiné soubory, vyznačte to zřetelně v popisu, nárocích a ve vlastním skriptu a domluvte se mnou e-mailem, jak ty soubory předáte, aby byla funkční ukázka skriptu.

Skripty, které obsahují chyby dle bodů 1-2 bez milosti vracím. Zatím není dořešená editace již vložených skriptů před jejich schválením, proto to probíhá tak, že dostanete mail se stručným popisem chyby. Když původní vkládaný skript ještě máte, pošlete mi ho opravený, českou i anglickou verzi, pokud ho nemáte a máte zájem ho opravit, napište zpátky mail a já Vám ho nakopírovaný pošlu.

3. Nejpodstatnější věc, jazykové mutace. Jak jste si jistě všimli, vkládáte všechny údaje skriptu nadvakrát, pro CZ a ENG verzi. Pokud tedy vkládáte cizojazyčný skript, musíte do češtiny přeložit:
   1. úvodní rubriky (tedy CZK Popis skriptu, CZK nároky na klienta, CZK nároky na server)
   2. veškeré texty ve skriptu, které se zobrazují na obrazovce (texty v HTML, popisky tlačítek, hlášení, apod )
   3. pokyny uživateli, jak má skript použít (což jsou například pokyny v komentáři ve skriptu jako)

      STEP ONE: Paste this code into the HEAD of your HTML document
      STEP TWO: Copy this code into the BODY of your HTML document
      

   4. další pokyny a popisky funkcí - jak se má skript volat, s jakými parametry, apod
   5. komentáře osvětlující obsah a chování skriptu či jeho součástí
   6. ve skriptu uvedené licenční podmínky a informace o autorovi či zdrojovém serveru

Obdobné pravidlo platí, pokud vkládáte český skript a přidáváte ENG verzi.

Důsledné dodržování těchto pokynů se vyhlašuje pro všechny skripty vložené od vyjití tohoto článku.

Co se týče již vložených skriptů, již schválené skripty opravím sám, u ještě neschválených , uplatním pravidlo:

• pokud kvalita algoritmu převáží nad překládaným textem, opravím také
• Jednodušší skripty, obsahující spíše výpočty a řadu hlášení či textu, vrátím k přepracování tím způsobem, že každému zašlu seznam jeho skriptů, které je třeba opravit, ať se sám rozhodne, zda to dopracuje

Věřím, že dodržování těchto pravidel povede k vytvoření kvalitního archivu skriptů, který se stane bonanzou myšlenek pro začínající i pokročilé programátory.

Verze pro tisk