Editorova příručka dobrých zásad

Tento průvodce se původně nazývá Editor's Guide for Good Policies. Zkratkou Egg Pol :)

Předmluva

Psaní zásad není exaktní věda. Je potřebná spousta úsudků, jako - co vzít dovnitř a co zůstane venku. Tato otázka se tady neřeší. Místo toho se tento průvodce zabývá tím, co známe a co můžeme ovlivnit v omezeném smyslu, takže se oprostíme od dalších úsudků, na čem záleží: slova.

Reference

Řídicí dokument se nazývá (Zásady ohledně zásad [Policy on Policy, PoP]). Tento dokument přebíjí vše, co je uvedeno v tomto dokumentu, který pouze přidává některé podrobné pracovní praktiky a posiluje Zásady ohledně zásad tam, kde je to k užitku.

Abyste měli z práce na zásadách dobrý pocit, konsultujte Rozhodnutí Skupiny zásad a Zásady. Přidejte se do seznamu, vyberte si jedny zásady a propracujte je svým vlastním způsobem.

Principy psaní zásad

  1. V komunitě platí jen jediná sada zásad.
    • To znamená, že každé zásady mají platnou vždy pouze jednu verzi.
  2. Skupina zásad má svobodu vypracovat koncepty variant.
  3. Zásady jsou závazné pro všechny členy komunity.
  4. Konečné slovo, co zásady říkají nebo znamenají, padne před arbitrem.
  5. Skupina pro zásady je otevřena všem členům komunity.
  6. Požadavek na zásady vychází z auditu.
  7. Měřítkem je hrubý všeobecný souhlas (konsensus).

Stav

Zásady ohledně zásad (PoP) definují tři stavy dokumentu na dráze zásad:

Jak uvidíte, je zásadní věc porozumět třem výše uvedeným stavům, abyste pochopili cokoli dalšího.

Formát dokumentů

Tato část předpokládá, že je dokument ve stavu Z8SADY (POLICY). Dokumenty ve stavech ROZPRACOVÁNO (WIP) a KONCEPT (DRAFT) by měly ve vlastním zájmu k tomuto formátování směřovat.

  1. Formátujte dokument vždy v prostém HTML.
    • vyžaduje se minimum stylistiky a formátování v HTML;
    • důvod: dokumenty jsou právně závazné a výtisk prostého HTML musí být snadno srozumitelný i pro netechnické osoby (arbitry, soudce);
    • dokument nesmí obsahovat žádná překvapení, žádné skryté části, žádné možnosti pro různý výklad a žádný způsob, jak by lidé přidávali poznámky, které by zatemnily smysl. Viz P1.
  2. Existuje pouze jeden dokument ZÁSADY. Ostatní kopie mohou být pracovní, ale musí:
    1. jasně uvádět, že jsou pracovní, jen pro účely Skupiny pro zásady,
    2. odkazovat na skutečné zásady jasným, výrazným způsobem, a to hned na svém začátku,
    3. musí být v živém užívání, nebo zastaralé k odstranění, a
    4. nesmí být neopatrně rozšiřovány mimo Skupinu pro zásady.

  3. Důstojník pro zásady může určit drobné záležitosti, viz p20100306;

    1. tyto změny nesmí ovlivnit smysl (význam) zásad;
    2. drobné záležitosti jsou:
      • URL, odkazy, kotvy
      • nadpisy
      • stav dokumentů
      • chyby gramatické, pravopisné nebo chyby v HTML
    3. Důstojník pro zásady uvědomí Skupinu pro zásady o dokončení změn.

Styl

Odkazy

  1. Odkazy na jiné zásady mají vypadat takto:

    1. První výskyt odkazu: Plný název zásad ("Zkratka" => COD číslo).

    2. Další výskyty už mohou používat jen zkratku.
    3. Oddíly (části) mají vypadat takto: (první výskyt) ... Oddíl #.# a (druhý výskyt) Zkratka #.# ["#" zastupuje číslo].

  2. Vnitřní odkazy: §#.#, kde symbol oddílu ["sect" - sekce, paragraf] je v HTML zapsán jako §

  3. URL lze použít, ale není to povinné. If used they are over the relevant part. URL samotné nejsou částí zásad.
  4. Seznam odkazů na konci dokumentu se nevyžaduje.

HTML

Používejte XHTML 1.1. Lze používat základní značky (tagy) HTML:

  1. <strong>, <b>, <em>, <i>, <cite>.

  2. Záhlaví

    • <h1> je název (titul). <h2> až <h5> jsou oddíly (paragrafy).

    • Záhlaví obsahuje číslování.
    • První oddíl je často očíslován nulou (0) a často se nazývá Předmluva (Preamble) nebo Úvod (Introduction). Je tradičně reservován pro kontext a vysvětlení atd., a má menší důležitost (tj. pravděpodobně neobsahuje text, který je důležitý co do závaznosti pro komunitu).

    • Používejte id="s#.#" pro kotvu ve značce <h#> takto: <h3 id="s2.3"> 2.3 Bla bla bla </h3> Písmeno 's' pro sekci (oddíl, paragraf, část) se v XHTML 1.1 vyžaduje, protože tam se nesmí začínat číslicemi.

    • Kde je text hutný, číslujte a ukotvujte oddíly, jako v Zásadách ohledně zásad (PoP).

  3. <blockquote>, <center>, <table>, <br>, <hr>.

  4. Styly (stylesheets):
    1. nepoužívejte je pro prvky zásad (těch závazných)
    2. reservujte nejvyšší, [přímo do dokumentu] vložený styl pro změny ROZPRACOVÁNO (WIP) a KONCEPT (DRAFT). Z konečného dokumentu zásad však musí zmizet.
    3. na použití vnějších stylů (souborů .css) se nesmíte spoléhat.

  5. <ul>, <ol>, <li>.

    • Používejte hodně seznamů pro dobré uspořádání bodů výkladu; nepíšeme přece beletrii.

Ověření

Zkontrolujte dokument ověřovací webovou aplikací na http://validator.w3.org/, než ho uložíte na hlavní web.

Záhlaví

Standardní záhlaví obsahuje:

Nejlepší je zkopírovat záhlaví z poslední verze dotyčných zásad. Až zvládneme patche a další, budeme to vše standardizovat.

Nevyžaduje se seznam změn ani datum změny (ale používejte je v rozpracovaných (WIP) nebo jiných pracovních dokumentech).

Typicky je doplněna také ikona, zarovnaná doprava.

Jiné obrázky. Zobrazené a tištěné verze dokumentu nesmí obsahovat dodatečné rušivé prvky, například reklamu.

Asi je lepší nevkládat ikonu ověřovače ani pomocí URL uvedeného níže, protože ověření nepracuje pomocí HTTPS a vložit je znamená, že musíme přemýšlet o jiných logo (pro CC [různé společnosti, stejná písmena CC, různé významy], prostou angličtinu, odvázanou "eggpol" [viz zkratku na začátku],...)

Úložiště dokumentů

Index dokumentů

Formálním indexem celé dráhy dokumentů zásad je Seznam řízených dokumentů (Controlled Document List, CDL), podle Konfigurace - řídicí specifikace (Configuration-Control Specification, CCS). Dodatek k CDL signalizuje, že dokument je na dráze zásad.

CDL obsahuje jen nejstručnější údaje, o čem dokument pojednává. Je to pouze index, ne úvod. Podrobnější informace viz Zásady.

Umístění dokumentů

1. Zásady ve stavu ZÁSADY (POLICY) musí být uloženy na hlavním webu na http://www.cacert.org/policy/ ve stejném režimu jako zdrojový kód. To je podřizuje řízení Zásad bezpečnosti (Security Policy), takže se s nimi zachází jako s patchi (záplatami, opravami) zdrojového kódu.

Z určitého důvodu jsou zásady uloženy pod názvem Jméno_zásady.php, tj. jako PHP program a ne jako soubor HTML.

2. Pracovní kopie zásad ve stavu KONCEPT (DRAFT) se mají uchovávat v úložišti SVN na http://svn.cacert.org/CAcert/Policies/

3. Vedoucí verze zásad ve stavu KONCEPT (DRAFT) mají být umístěny na hlavní web (jako v bodu 1. výše) a označeny jako KONCEPT (DRAFT) na vědomí komunitě.

4. ROZPRACOVANÉ (WIP) dokumenty mohou mít jakoukoli formu. Typicky jsou starší dokumenty umístěny na Wiki a jsou přeformátovány do HTML zhruba v době, kdy se uvažuje o jejich přechodu do stavu KONCEPT (DRAFT).

Publikování změn stavu na koncept zásad

Jakmile dokument zásad přejde do stavu KONCEPT (DRAFT), může být uvolněn k publikaci na hlavní web na http://www.cacert.org/policy/. Provede se to odesláním patche týmu posuzování softwaru. Zde je něco jako návod, zaměřený na Skupinu pro zásady.

  1. K přípravě patche potřebujete získat lokální úložiště GIT. Postupujte podle instrukcí zde k získání lokálního úložiště pro cacert-git.

  2. Jakmile je úložiště vytvořeno a v činnosti, proveďte git pull, čímž ho aktualizujete (zvláště jindy než poprvé).

  3. Příkazem cd přejděte do www/policy.
  4. Proveďte zamýšlené změny souboru(ů) obsahujících zásady.
    • Připomínám, že soubor by měl mít příponu .html
    • Zkontrolujte a zajistěte, aby se URL lišily od svých tvarů v SVN; zvláště URL na zásady mají být relativní a odkazovat název souboru pouze relativně.

  5. Proveďte git commit

    • Na prvním řádku zprávy "commit" uveďte rozhodnutí o zásadách.

  6. Proveďte git format-patch origin

    • Tím se vytvoří soubor s názvem podobným 0001-my-first-change-to-a-policy-p20101225.patch [0001-moje-první-změna-zásad-p20101225.patch]
  7. pošlete e-mail na cacert-devel
    • s krátkým vysvětlením,
    • předmět nechť obsahuje "Předmět" (Subject) z patche,
    • soubor patche dejte do přílohy.

Připomínám, že rozhodnutí o zásadách opravňuje k publikování zásad, ale posuzovatel softwaru (Software Assessor) musí překontrolovat samotný patch.

Tvorba rozhodnutí

Pracovní postup

Označení změn a připomínek

Změny vložené do KONCEPTu dokumentu zásad musí být jasně označeny. Má být přiložen souhrn změn, na nichž se pracuje, jasně oddělený od vlastních zásad.

Navrhované změny by měly být označeny MODŘE. Text k vypuštění má být také přeškrtnut vodorovnou čarou.

Komentáře by měly být ZELENÉ. Komentáře (připomínky) nejsou nikdy součástí zásad.

Viz příklady stylů na začátcích zásad v SVN (v HTML).

Hrubý konsensus

Rozhodnutí jsou vytvářena metodou hrubého konsensu, koncepce vypůjčené od IETF: http://www.cacert.org/policy/PolicyOnPolicy.php#s2.3 (Zásady ohledně zásad, §2.3).

Hrubý konsensus leží asi tak mezi jednomyslným přijetím a převážnou většinou. Prostá většina hlasů (od 51%) nepostačuje, ale 100% hlasů se nevyžaduje.

Prakticky to znamená, že veškerá kritika musí mít dostatečný prostor, tak aby měl každý rovnou možnost se vyjádřit. Také se však uznává, že se vždy najde někdo, kdo nesouhlasí. Dokonalé je nepřítel dobrého, a Zásady ohledně zásad (PoP) i Zásady řešení sporů (DRP) poskytují možnost budoucí nápravy chyb.

Hlasování o rozhodnutích

Kde je rozhodnutí důležité (například má závazný účinek na komunitu) nebo je kontroverzní, rozhodne se hlasováním. Rozhodnutí hlasováním lépe podpoří budoucí arbitráže.

Hlasy jsou vyžádány v návrhu řešení na (e-mailovém) seznamu adresátů skupiny pro zásady. Řešení může navrhnout kdokoli, ale obecně vzato je lépe napřed je prodiskutovat.

Na shromáždění hlasů by měl být čas aspoň týden a u obtížných rozhodnutí až čtyři týdny. Pokud je tendence směřovat k závěru, hlasování může být prodlouženo. Čas na rozhodnutí musí být řádně oznámen.

Během hlasovacího období pravděpodobně vyvstanou změny. Nekontroverzní změny (formulace, chyby) mohou být přijaty bez rozruchu. Změny většího dopadu musí být probrány a jsou-li podepřeny konsensem vloženy do dokumentu. Zvažte upomenutí voličů a prodloužení doby hlasování.

Záznamy rozhodnutí

Návrh, hlasování a číslo rozhodnutí jsou zaznamenávány do Rozhodnutí o zásadách. Lze použít buď odkaz na osobu, nebo "vlákno" [asi: konverzaci v seznamu adresátů e-mailu o zásadách]. Přínosné je také použití jmen, protože oceňuje námahu, kterou ten který člověk vynaložil na práci se zásadami.

Číslo rozhodnutí je definováno zde; je to písmeno 'p' a datum. Je to obvykle datum prvního návrhu, není to datum ukončení hlasování. Datum účinnosti není definováno (což znamená, že závisí na arbitrovi v nějakém sporu).

Autorita

Zdroj autority. Zásady ohledně zásad (Policy on Policy, PoP) je oficiální dokument, který dává Skupině pro zásady pověření (mandát) vydat zásady, které jsou pro Komunitu závazné.

Rozsah. Které dokumenty se stanou zásadami, je definováno postupem auditu, zvláště Kritériem Davida Rosse (DRC)-A.1, které definuje sadu oficiální dokumentace vyžadované u CA. DRC-A.1 nařizuje vytvořit Konfiguraci-řídicí specifikaci (CCS) (nyní existuje ve stavu KONCEPT [DRAFT]). Velkou částí CCS jsou zásady, které jsou samy řízeny Zásadami ohledně zásad (Policy on Policy). 

      Audit => DRC => DRC-A.1 => CCS => PoP

Dokumenty požadované při auditu, nebo managementem pokládané za auditem vyžadované, jsou označeny za zásady. Tyto dokumenty dostanou číslo COD podle schématu Oficiálního dokumentu CAcert, které je uloženo v Seznamu řízených dokumentů (Controlled Document List, CDL).

Výjimky. Jsou dvě významné výjimky ze svrchovanosti Skupiny pro zásady. Za prvé, celé zásady ve stavu KONCEPT (DRAFT) může vetovat Výbor, aby se vypořádal se zásadami, které z jeho pohledu představují nepřijatelné nároky na sdružení. Ovšem jakmile se stav zásad změnil na ZÁSADY (POLICY), tato výjimka už neplatí. Za druhé, všechny spory řeší arbitráž CAcertu. Proto poskytují tyto dvě výjimky důkladnou ochranu "před a po" [přechodu do stavu ZÁSADY].

Původ. Tuto roli měl původně Výbor CAcert, Inc., a to až do TOP (vrcholové schůzky) Pirmasens 2007. Na této schůzce schválil Výbor závazný účinek tří klíčových zakládajících dokumentů (PoP, DRP, CCA [Zásady ohledně zásad, Zásady řešení sporů, Dohodu komunity CAcert]). Zschválením přechodu PoP do stavu KONCEPT (DRAFT) přenechal Výbor hlasování o závaznosti zásad Skupině pro zásady. Klíčové zakládající dokumenty byly později potvrzeny valnou hromadou sdružení a schváleny jako ZÁSADY (POLICY) samtnou Skupinou pro zásady. Tyto dokumenty společně vytvářejí základ silného řízení pro komunitu a ostatní dokumenty zásad.

Různé

Jazyk

Jazykem zásad CAcert je angličtina, je také jazykem všech sporů před arbitráží.

Preferuje se australská angličtina. Je téměř stejná jako britská a lze ji považovat za ekvivalentní. Hlavní rozdíl mezi ní a severoamerickou variantou je poněkud zjednodušený pravopis severoamerické angličtiny.

Při psaní dejte přednost prosté, jednoduché angličtině, protože mateřským jazykem většiny komunity není angličtina. Jsou-li věty příliš komplikované, zkuste je napsat jinak. Používejte kratší výrazy a krátká slova :) . Přidejte interpunkci (severoamerická angličtina má tendenci vypouštět čárky).

Zásady CAcert neskrývají svou obtížnost, pokoušejí se však řešit obtížná témata a ukázat je, když je nemůžeme vyřešit.

Ačkoli jsou překlady povoleny, ve většině případů se nedoporučují. V překladech vznikají problémy: spousta práce; tendence zastarávat (změny probíhají rychleji, než překlady do všech jazyků); vedou k neúplnému pochopení pro chyby v překladech.

Rod. Nejčastější způsob použití rodu v dokumentech zásad je použití kryptografických konvencí poprvé popsaných v článku RSA. Ref.: Wikipedia [anglická]. Při této metodě dostane každá strana jméno, které označuje rod. Alice je první, Bob druhý, Carol třetí, atd. V komunitě CAcert říkáme nejčastěji, že Alice je členem a Bob zaručovatelem. Všimněte si, že to je konvence přijatá jako praktika, ale nejsou to zásady.

Dokumenty, které nejsou zásady

Jiné dokumenty, které jsou užitečné, ale nepatří do oboru zásad, nechť jsou nazvány jinak, abynedošlo k mýlce. Například: příručka, průvodce, praktiky atd. Kde se to hodí, mohou zásady pověřit tvorbu takových dokumentů.

SPOLEHNUTÍ (RELIANCE)

Jelikož se zabýváme PKI a CA, termíny SPOLEHNOUT a POUŽÍT jsou často psány písmeny velké abecedy, aby to označovalo jejich zvláštní význam. Variace mohou být také SPOLEH[NUTÍ] (RELIANCE) a POUŽITÍ (USAGE).

(Jejich význam není definován zde. Viz Přehled postupů certifikace [Certification Practise Statement, CPS] a Dohoda komunity CAcert [CAcert Community Agreement, CCA].)

IETF

[Internet Engineering Task Force, Skupina pro výstavbu Internetu]

Upozorňujeme, že některé konstrukce jsme si vypůjčili z procesu IETF RFC [Request For Comments]. Zejména používáme "hrubý konsensus", ale ten je popsán výše.

Termíny "musí, měl by, může" se zpravidla používají ve stejném významu jako v IETF RFC2119, nejsou však psány písmeny velké abecedy (kapitalizovány, viz výše u SPOLEHNUTÍ [RELIANCE]).

Tyto praktiky však neznamenají, že i jiné části jsou převzaty od IETF; naše vlastní postupy se vyvinuly nezávisle a "vypůjčili" jsme si pouze malou část.

Duševní vlastnictví

[Intellectual Property]

Podle Zásad ohledně zásad (PoP) jsou veškeré příspěvky k zásadám CAcert převedeným vlastnictvím nebo pod plnou licencí CAcert Inc. (PoP 6.2). To znamená, že přidáte-li na seznam adresátů poznámku / připomínku nebo ji zašlete na wiki, nebo ji sdílíte v soukromé e-mailové zprávě s těmi, kteří pracují na zásadách, mohou být tato Vaše slova a nápady použity.

Licence

CAcert opět v (PoP 6.4) licencuje dokumenty dávané vně svobodnou a otevřenou licencí "Creative Commons - Attribution - ShareAlike 3.0 Australia", kde odkazuje všechny spory na naši arbitráž podle Zásad řešení sporů (DRP). To je známější pod zkratkou CC-by-sa, nebo úplnější CC-by-sa-3.0-AU+DRP.

Slovo vydavatele (Editorial)

Odkaz. Za účelem odkazu na licenci v textu použijte tento tvar (vše na jednom řádku) v titulním bloku: 

Licence:
  <a href="wiki.cacert.org/Policy#Licence"
  title="this document is Copyright CAcert, licensed openly under CC-by-sa with all disputes resolved under DRP. More at wiki.cacert.org/Policy" >
  CC-by-sa/DRP </a>
  <br />

[...tento dokument je Copyright CAcert licencovaný otevřeně podle CC-by-sa se všemi spory řešenými podle DRP. Více na wiki.cacert.org/Policy]

Pozor: uvedený odkazový řádek má stav ROZPRACOVÁN (Work-In-Progress).

Pravopis. V licenci je použit pravopis britsko/australské angličtiny: licence je podstatné jméno a to license [licencovat] je sloveso.

Potvrzení Vašeho příspěvku

Momentálně nemáme způsob, jak vyznačit Váš příspěvek k zásadám v jejich textu. Přidat do textu copyright to nevyřeší, neboť obsah je přenášen automaticky, jak uvedeno výše.

K revizi

Styl a formát

Jsou to dokumenty s auditem sice nesouvisející, ale z historických důvodů sledovaly část "dráhy" zásad.

/!\ Dokument je nyní zařazen do CDL jako COD3 a obsahuje mj. zásady formátování. /!\

Další stránky ke čtení

Zastaralé

Policy/Guide/CZ (last edited 2016-06-06 08:12:10 by AlesKastner)