Zoznamy s odrážkami: pravidlá písania, štruktúra a príklady

Zoznam s odrážkami je neusporiadaná množina súvisiacich, nezávislých bodov. Umožňuje čitateľovi raz rozpoznať kategóriu a potom prechádzať jednotlivé členy bez toho, aby ich musel vyťahovať z odseku. Používajte odrážky len vtedy, keď položky patria na rovnakú logickú úroveň a ich poradie nemení význam.

• Každú položku začnite rovnakým gramatickým tvarom.
• Udržujte každú položku v rovnakej dĺžkovej kategórii.
• Množinu uveďte pred prvou odrážkou.
• Po poslednej odrážke sa vráťte k argumentácii.

Tento vykreslený príklad je skutočný zoznam: štyri rovnocenné pravidlá, všetky formulované ako rozkazovacie vety, žiadne závislé od pozície. Odsek vyššie stanovuje kategóriu; veta nižšie vysvetľuje, čo množina dokazuje. Odrážky zlepšujú prístup k argumentu bez toho, aby ho nahrádzali.

Prečo je tento prvok dôležitý

Čitatelia neprechádzajú odsek ako vrece viet. Hľadajú tvrdenie, sledujú vzťah medzi myšlienkami a rozhodujú, či vysvetlenie stojí za pozornosť. Zoznam s odrážkami toto správanie mení. Jeho vertikálny rytmus signalizuje: „tieto body sú rovnocenné; môžete ich skúmať jeden po druhom.“ To znižuje úsilie potrebné na nájdenie relevantnej požiadavky, možnosti, príznaku alebo vlastnosti.

Rovnaká hranica zlepšuje strojovú extrahovateľnosť: schopnosť vyhľadávača, AI systému alebo transformátora obsahu izolovať položky pri zachovaní ich spoločného kontextu. Sémantický neusporiadaný zoznam explicitne odhaľuje kolekciu a jej členov. Paralelné úvodné slová tiež pomáhajú stroju odvodiť, že položky vykonávajú rovnakú úlohu. „Vyžaduje administrátorský prístup“, „Vyžaduje overenú doménu“ a „Vyžaduje aktívne predplatné“ tvoria jasnejšiu množinu ako tri položky, ktoré sa striedajú medzi otázkami, fragmentmi a komentármi.

Odrážky nie sú automaticky jasnejšie ako próza. Odsek vyjadruje príčinu, kontrast, kvalifikáciu, postupnosť a záver prostredníctvom viet a prechodov. Premena na odrážky môže tieto vzťahy vymazať. Zoznam potom vyzerá jednoduchšie, ale komunikuje menej. Toto je hlavné riziko prvku: vizuálna skenovateľnosť môže maskovať stratenú logiku.

Pravidlá písania prvkov majú prednosť. Identifikujte, čo pasáž robí, skôr než zvolíte jej vzhľad. Zhrnutie záverov patrí do kľúčových zhrnutí , aj keď tento prvok vykresľuje odrážky. Usporiadané inštrukcie patria do zoznamu krokov . Zoznam s odrážkami je správny prvok len vtedy, keď je jeho účelom prezentovať neusporiadanú množinu rovnocenných položiek v rámci okolitej argumentácie.

Kedy ho použiť

Použite zoznam s odrážkami, keď jeden úvod môže presne riadiť tri alebo viac položiek a každá položka zostáva užitočná pri samostatnom čítaní. Silné použitia zahŕňajú požiadavky, vlastnosti, príklady z jednej kategórie, nesequenčné možnosti, príznaky zlyhania, kritériá zahrnutia a kompaktné odporúčania rovnakej priority.

Pred prevodom prózy vykonajte tri testy:

1. Test rovnocennosti: Môže každá položka odpovedať na rovnakú implikovanú otázku?
2. Test poradia: Môžu dve susedné položky vymeniť miesta bez zmeny inštrukcie alebo záveru?
3. Test kontextu: Poskytuje úvod dostatok kontextu pre každú položku bez toho, aby ho každá musela opakovať?

Ak všetky tri prejdú, odrážky pravdepodobne pomôžu. Ak test poradia zlyhá, použite číslované inštrukcie alebo chronologickú prózu. Ak test rovnocennosti zlyhá, rozdeľte materiál na samostatné odseky alebo nadpisy. Ak test kontextu zlyhá, každý bod potrebuje vlastné vysvetlenie.

Osobitnú pozornosť si zaslúžia takmer zásahy:

• Sada úkonov nie je zoznam s odrážkami, keď jeden úkon odomyká ďalší; ide o usporiadaný postup.
• Sada tvrdení nie je zoznam, keď druhé kvalifikuje prvé a tretie robí záver; ide o argumentáciu.
• Sada produktov nie je nevyhnutne zoznam, keď čitatelia potrebujú hodnotenie kritérium po kritériu; použite porovnávaciu tabuľku .
• Sada dokončovacích brán nie je len informačná, keď musí čitateľ každú overiť; ide o kontrolný zoznam.
• Dve alternatívy len zriedka odôvodňujú odrážky. Napíšte „Použite X, keď…; použite Y, keď…“, pokiaľ každá nevyžaduje podstatné vysvetlenie.

Nepoužívajte odrážky na záchranu príliš dlhého odseku skôr, než diagnostikujete, prečo je dlhý. Odsek môže obsahovať niekoľko tvrdení, chýbajúce nadpisy alebo nevyvinutý kauzálny reťazec. Najprv opravte tú štruktúru. Odrážky nie sú univerzálnym čistiacim nástrojom.

Kam ho umiestniť

Umiestnite zoznam s odrážkami ihneď po úplnom úvode, ktorý pomenuje množinu a vysvetlí, prečo ju čitateľ potrebuje. „Migrácia vyžaduje:“ je gramatické, ale slabé, pretože nestanovuje dôsledok. „Pred migráciou zhromaždite tieto štyri vstupy, aby rollback mohol obnoviť pôvodný stav:“ hovorí čitateľovi, čo položky sú a prečo sú dôležité.

Interpretáciu umiestnite ihneď po zozname, keď položky podporujú rozhodnutie alebo tvrdenie. Záverečný odsek by mal identifikovať vzor, prioritu, výnimku alebo ďalší krok vytvorený množinou. Zoznam môže ukončiť malú referenčnú časť, keď je účel čisto enumeračný, ale nesmie ponechať argumentáciu nedokončenú.

Presné pravidlá umiestnenia:

• Uveďte úvod a zoznam v rovnakej sekcii; nikdy nenuťte čitateľa prekračovať nadpis, aby zistil, čo odrážky vymenúvajú.
• Udržujte dôkazy vedľa tvrdenia, ktoré podporujú. Nevkladajte zoznam medzi tvrdenie a jeho citáciu, výpočet alebo kvalifikáciu.
• Neumiestňujte neusporiadaný zoznam priamo vedľa usporiadaného zoznamu bez prechodu, ktorý vysvetlí zmenu významu.
• Neklaďte dva zoznamy s odrážkami tesne za seba. Pridajte interpretáciu, zlúčte skutočne rovnocenné položky alebo dajte každej kolekcii popisný podnadpis.
• Neumiestňujte všeobecný zoznam s odrážkami priamo pod blok kľúčových zhrnutí, keď obe sumarizujú rovnaký materiál.
• Neumiestňujte výzvu na akciu do poslednej odrážky. Ukončite kolekciu, vysvetlite záver a potom prezentujte akciu samostatne.

Prvok sa môže na dlhej stránke vyskytovať niekoľkokrát, no vzťahy medzi týmito zoznamami musí niesť próza. Keď sa každá sekcia stane nadpisom plus odrážkami, stránka trpí zlyhaním osirelých zoznamov: kolekcie existujú, ale nič nevysvetľuje, ako sú prepojené.

Anatómia

Kompletný zoznam s odrážkami má päť sémantických oblastí:

1. Kontext: predchádzajúce tvrdenie alebo vysvetlenie, ktoré robí kolekciu relevantnou.
2. Úvod: celá veta, ktorá pomenúva zdieľanú kategóriu.
3. Kontajner zoznamu: jeden sémantický neusporiadaný zoznam, ktorý stanovuje vzťah položiek.
4. Položky: rovnocenné tvrdenia s paralelnou gramatikou a konzistentnou úrovňou detailov.
5. Interpretácia: nasledujúca veta alebo odsek, ktorý znovu pripája množinu k argumentácii.

Značka, odsadenie a medzery robia hierarchiu viditeľnou, ale nedefinujú ju. Štruktúra zdroja musí zostať neusporiadaným zoznamom, keď štýly, skripty a vizuálne značky chýbajú.

Príklady dizajnu

Dizajnový systém podporuje tri varianty. Ich obsahová zmluva zostáva rovnaká; mení sa len hustota a rozloženie.

Predvolený

Použite predvolený jednostĺpcový variant pre úplné tvrdenia a väčšinu redakčného obsahu. Každej položke poskytuje dostatok oddelenia na skenovanie, pričom množinu udržiava vizuálne prepojenú.

Kompaktný

Použite kompaktné medzery pre štítky, krátke požiadavky alebo hodnoty s 3–12 slovami. Kompaktný nie je povolenie stláčať logiku do fragmentov; okolitá próza stále poskytuje kontext.

Dvojstĺpcový

Použite dva stĺpce len pre šesť až desať krátkych nezávislých položiek, ktoré zostávajú zrozumiteľné v poradí čítania renderovača. Pri úzkych šírkach musí rozloženie skolabovať do jedného stĺpca. Nepoužívajte ho pre vysvetlené body, manuálne krížové stĺpcové usporiadanie alebo položky, ktorých poradie naznačuje ranking.

Žiadny variant nesmie nahradiť natívnu sémantiku zoznamu dekoratívnymi ikonami a nesúvisiacimi kontajnermi. Vizuálne prispôsobenie musí zachovať jednu kolekciu a jednu položku na tvrdenie.

Parametre

Nižšie uvedené limity bránia tomu, aby sa zoznamy rozširovali až do bodu, kedy by mali byť sekciami. „Zdroj“ identifikuje, kde je autoritatívna hodnota vytvorená.

Renderer neodvodzuje názov z úvodu. Názov pomenúva znovu použiteľný blok alebo blok definovaný typom príspevku; úvod dokončuje vzťah na úrovni vety medzi okolitou prózou a položkami. Väčšina vložených zoznamov nepotrebuje názov.

Syntax a príklady kódu

Všetky tri mapovania zachovávajú rovnaký úvod, položky, variant a interpretáciu. Prenosná direktíva je autoritatívna. Príklady Hugo a WordPress popisujú platformové adaptéry; nepovoľujú štylovanie špecifické pre stránku.

Prenosná Markdown direktíva

:::bullet-list{variant=default}
Pred publikovaním skontrolujte tieto podmienky:

- Tvrdenie uvádza svoj rozsah a časové obdobie.
- Zdroj podporuje presne použité znenie.
- Stránka vysvetľuje akékoľvek podstatné obmedzenie.

Spoločne tieto kontroly udržujú obhájiteľné tvrdenie predtým, než sa stane prehnaným.
:::

Hugo shortcode

{{< bullet-list variant="default" >}}
Pred publikovaním skontrolujte tieto podmienky:

- Tvrdenie uvádza svoj rozsah a časové obdobie.
- Zdroj podporuje presne použité znenie.
- Stránka vysvetľuje akékoľvek podstatné obmedzenie.

Spoločne tieto kontroly udržujú obhájiteľné tvrdenie predtým, než sa stane prehnaným.
{{< /bullet-list >}}

Kým projekt nezaregistruje tento adaptér, vykreslite obsah ako obyčajný sémantický Markdown namiesto vymýšľania lokálneho shortcode. Zdroj stále spĺňa redakčnú zmluvu.

WordPress

<!-- wp:amicited/bullet-list {"variant":"default"} -->
<p>Pred publikovaním skontrolujte tieto podmienky:</p>
<ul>
  <li>Tvrdenie uvádza svoj rozsah a časové obdobie.</li>
  <li>Zdroj podporuje presne použité znenie.</li>
  <li>Stránka vysvetľuje akékoľvek podstatné obmedzenie.</li>
</ul>
<p>Spoločne tieto kontroly udržujú obhájiteľné tvrdenie predtým, než sa stane prehnaným.</p>
<!-- /wp:amicited/bullet-list -->

Ak neexistuje vlastný blok, natívne bloky WordPress List a Paragraph sú správnym prístupným zálohovaním. Zachovajte variant obalu len vtedy, keď ho téma podporuje.

Príklady

Dobrý: paralelné kontroly publikovania

Pred schválením porovnania overte, že každá možnosť dostáva rovnaké zaobchádzanie:

• Aplikujte rovnaké hodnotiace kritériá na každú možnosť.
• Používajte dôkazy z ekvivalentných časových období.
• Uveďte podstatné obmedzenia vedľa ovplyvneného tvrdenia.
• Oddeľte namerané fakty od redakčného úsudku.

Tieto položky fungujú, pretože odpovedajú na jednu otázku – čo robí porovnanie spravodlivým – a každá začína rozkazovacím slovesom nasledovaným jedným objektom. Ich dĺžky sú podobné, poradie je zameniteľné a záverečná veta vysvetľuje spoločný štandard.

Zlý: argument rozbitý na odrážky

• Čitatelia skenujú stránky.
• Pretože skenovanie je bežné, zoznamy sú užitočné.
• Ale zoznamy odstraňujú prechody.
• Preto používajte zoznamy opatrne a testujte prístupnosť, ktorá tiež záleží pre čítačky obrazovky a má niekoľko implementačných detailov.

Toto je zlé, pretože položky nie sú rovnocenné. Tvoria premisu, odvodenie, kvalifikáciu a záver, takže ich presúvanie mení argument. Ich gramatika a dĺžka tiež kolíšu. Prepísanie pasáže na odrážky odstránilo spojovaciu logiku pri zachovaní prechodových slov, ktoré odhaľujú skrytý odsek. Napíšte to ako prózu: čitatelia skenujú stránky, takže zoznamy im môžu pomôcť nájsť rovnocenné body; avšak zoznamy odstraňujú prechody, čo znamená, že autor musí zachovať logiku pred a po množine.

Schema značky a prístupnosť

Bežný zoznam s odrážkami nepotrebuje samostatnú schema značku. Zostáva viditeľným obsahom v rámci obklopujúceho typu Article, TechArticle, popisu produktu alebo iného typu na úrovni stránky. Nevytvárajte značku ItemList len preto, že HTML obsahuje <ul>; štruktúrované údaje by mali reprezentovať zmysluplnú kolekciu entít, nie každé vizuálne vymenovanie.

ItemList môže byť vhodný, keď samotný zoznam je hlavnou, konečnou kolekciou – ako napríklad deklarovaná množina zahrnutých lokalít alebo hodnotených produktov – a každá viditeľná položka sa mapuje na skutočný ListItem. Pre neusporiadanú kolekciu nevymýšľajte poradie ani neimplikujte preferenciu prostredníctvom position. Výstup schemy sa musí zhodovať s viditeľným počtom a názvami. Väčšina redakčných odrážok priamo nevyživuje žiadnu vlastnosť schemy.

Prístupnosť začína <ul> a jedným <li> na položku. Nepíšte znaky odrážok do odsekov, nevkladajte zalomenia riadkov na napodobnenie položiek ani nepoužívajte sériu <div> prvkov len preto, že CSS dokáže kresliť značky. Čítačky obrazovky ohlasujú natívne hranice zoznamu a počty položiek, čo dáva používateľom rovnaký kategorický signál, aký dostávajú vizuálni čitatelia.

Udržujte vnorenie na jednej úrovni a len vtedy, keď každé dieťa patrí k svojmu rodičovi. Vnorený zoznam potrebuje aspoň dve položky; jedna odsadená položka je zvyčajne ďalšia veta. Zabezpečte, aby vlastné ikony nemali konkurenčný prístupný názov, keď sú dekoratívne. Odkazy musia opisovať svoj cieľ a význam nesmie závisieť od farby, tvaru alebo stĺpcovej pozície značky. Dvojstĺpcový výstup musí zachovať predvídateľné poradie zdroja a klávesnicového čítania.

Pravidlá písania

Vyberte si jednu z troch dĺžkových kategórií položiek a používajte ju v celom zozname:

• Skenovacie štítky: 3–12 slov. Používajte pre nástroje, požiadavky, príznaky alebo kompaktné členy kategórie.
• Úplné tvrdenia: 8–25 slov. Používajte pre pravidlá, výhody, kritériá a odporúčania, ktoré stoja samostatne.
• Vysvetlené body: 20–45 slov. Používajte, keď každá položka potrebuje jeden dôvod alebo kvalifikáciu; dlhšie vysvetlenia presuňte do prózy alebo podsekcií.

Používajte normálne tri až sedem položiek. Dve položky sa hodia do vety alebo kontrastu. Osem až desať položiek vyžaduje jasný dôvod, zámerné zoskupenie a zvyčajne kompaktný alebo dvojstĺpcový variant. Viac ako desať núti čitateľov vytvárať si vlastné kategórie; rozdeľte množinu alebo zaveďte podnadpisy.

Paralelná konštrukcia je povinná. Každú položku začnite rovnakým slovným druhom a zachovajte rovnaký implikovaný podmet. Dobré množiny používajú rozkazovacie slovesá („Potvrďte“, „Zaznamenajte“, „Otestujte“), podstatné mená („Prístup“, „Dôkaz“, „Vlastníctvo“) alebo úplné oznamovacie vety. Nezačínajte jednu položku slovesom, druhú „Mali by ste“ a tretiu otázkou.

Zlaďte tón, čas, interpunkciu, veľkosť písmen a detaily. Používajte malé písmená s výnimkou prvého slova. Celé vety ukončite bodkou; vynechajte bodku pri krátkych fragmentoch. Rozlišujúce slová umiestnite na začiatok namiesto opakovania dlhého rovnakého úvodu. Tučné písmo môže identifikovať krátky štítok nasledovaný vysvetlením, ale každá položka musí používať rovnaký vzor štítkov.

Nikdy nedávajte do bežného zoznamu s odrážkami:

• Povinné usporiadané úkony, ktorých poradie ovplyvňuje výsledok.
• Niekoľko odsekov, viacero nadpisov alebo samostatný mini-článok na položku.
• Tabuľky, formuláre, videoprehrávače, referencie alebo propagačné karty.
• Nekvalifikované tvrdenia, ktoré sa spoliehajú na kontext mimo položky, aby zostali presné.
• Zmes požiadaviek, príkladov, záverov a výziev na akciu.

Vyhnite sa zlyhaniu osirelých zoznamov. Dochádza k nemu, keď je takmer každý odsek prevedený na odrážky, pričom nezostáva žiadna próza na stanovenie príčiny, konfliktu, dôkazu alebo záveru. Praktickým signálom na kontrolu sú tri po sebe nasledujúce sekcie, ktoré každá obsahujú krátky úvod a zoznam, ale žiadny interpretačný odsek. Obnovte najsilnejšie tvrdenie do prózy, skombinujte prekrývajúce sa kolekcie a ponechajte len zoznamy, ktoré prejdú testami rovnocennosti, poradia a kontextu.

Typy príspevkov, ktoré ho používajú

Riadky nižšie sú riadené frontmatter postTypes. „Použitie“ opisuje úlohu odrážok, nie požiadavku vnútiť ich do každej stránky.

Kontrolný zoznam QA

Pred publikovaním overte každú položku:

• Úvod pomenúva jednu kategóriu a vysvetľuje, prečo množina záleží.
• Každá položka odpovedá na rovnakú implikovanú otázku a je na rovnakej logickej úrovni.
• Preskupenie položiek by nezmenilo inštrukciu, chronológiu ani argument.
• Všetky položky používajú paralelnú gramatiku, tón, čas, veľkosť písmen a interpunkciu.
• Každá položka zostáva v rámci jednej zvolenej dĺžkovej kategórie a zoznam obsahuje 3–7 položiek alebo odôvodnenú výnimku.
• Zoznam používa sémantický výstup <ul> a <li> namiesto dekoratívnych znakov odrážok.
• Vnorené položky končia na jednej úrovni, pričom stĺpce zachovávajú predvídateľné poradie čítania.
• Odkazy sú opisné, overené a obmedzené na jeden primárny cieľ na položku.
• Odsek po zozname uvádza interpretáciu, keď množina podporuje argument.
• Zoznam neduplikuje typované zhrnutie, kontrolný zoznam, zoznam krokov, tabuľku ani iný účelovo špecifický prvok.
• Stránka obsahuje dostatok prózy na prenášanie logiky medzi kolekciami a vyhýba sa zlyhaniu osirelých zoznamov.
• Mapovania pre prenosný Markdown, Hugo a WordPress zachovávajú rovnaké položky a význam.

FAQ

Koľko položiek by mal obsahovať zoznam s odrážkami? Používajte normálne tri až sedem. Dlhšie množiny zoskupujte alebo rozdeľte namiesto toho, aby ste nechali čitateľa kategorizovať ich bez pomoci.

Aká dlhá by mala byť každá odrážka? Vyberte si jednu kategóriu pre celý zoznam: 3–12, 8–25 alebo 20–45 slov. Konzistentnosť je dôležitejšia ako dosiahnutie maxima.

Mali by položky s odrážkami končiť interpunkciou? Používajte bodky pre celé vety a žiadnu koncovú interpunkciu pre krátke fragmenty. Aplikujte rozhodnutie konzistentne.

Môžu zoznamy s odrážkami obsahovať odkazy? Áno, ale používajte opisné kotvy a normálne najviac jeden primárny odkaz na položku.

Kedy by sa odrážky mali stať číslovanými krokmi? Používajte čísla, keď poradie ovplyvňuje výsledok. Neusporiadané odrážky sľubujú, že poradie nezáleží.

Zoznamy s odrážkami fungujú, keď odhaľujú skutočnú kolekciu a próze nechávajú priestor na logiku. Cieľom nie je maximalizovať skenovateľnosť na každom riadku; je uľahčiť nájdenie rovnocenných bodov bez zničenia vzťahov, ktoré ich robia zmysluplnými.