Na prostem:Navodila za pisce spletne knjige

Iz Na prostem
Pojdi na navigacijo Pojdi na iskanje

Nastanek spletne knjige

Spletna knjiga XY je nastala kot rezultat projekta Na-prostem.si (2022-2023). Namen projekta je ustvariti pogoje za povečanje uporabe t. i. prostega programja in storitev, ki se razvijajo v odprtokodni skupnosti. Ciljne skupine projekta so nevladne organizacije ter med njihovimi uporabniki posamezniki z invalidnostmi in socialno ranljivi. V projektu smo razvili in izvedli vrsto izobraževanj - za namen spodbujanja uporabe odprtokodnih programskih rešitev. Nevladnim organizacijam nudimo tehnično podporo pri uporabi programske opreme. Priskrbimo tudi obnovljeno rabljeno računalniško opremo vsem trem ciljnim skupinam. Ob koncu projekta načrtujemo postavitev stalne rešitve za izvajanje redne podpore nevladnim organizacijam pri uporabi odprtokodnih programov. V želji doseči dolgoročne učinke projekta, s čimer bi v projektu razvite rešitve lahko nudili tudi v nadaljevanju razvijamo sistem nudenja pomoči nevladnim organizacijam pri uporabi odprtokodnih programov. Vzpostavili smo forum, da bi podprli razvoj skupnosti ter spodbudili posameznike, ki imate znanja in izkušnje za sodelovanje pri nudenju podpore nevladnim organizacijam v bodoče. Spletna knjiga XY je nastala v tem kontekstu.

Namen spletne knjige

Da bi lahko širili uporabo odprtokodnih programov, je smiselno nasloviti pomanjkanje informacij, znanj in veščin, potrebnih za to, da se posameznik ali neka organizacija sploh odloči za uporabo teh programov in pri njej lahko vztraja. V ta namen ima forum prostor tudi za pomoč uporabnikom iz česar izhaja zbirka pogostih vprašanj in odgovorov. Ker pa nagovarjamo računalniške laike, smo se odločili za oblikovanje te spletne knjige. Spletna knjiga XY je tako namenjena posameznikom, ki jim računalniški svet ni domač.

Vsebina spletne knjige

Iz kazala je razvidno, da smo spletno knjigo zastavili zelo široko. Izpostavljamo razumevanje odprtokodnih rešitev, teme povezane z digitalno dostopnostjo in vključevanjem ter teme s področja ozaveščanja značilnosti digitalne družbe na sploh. Pod naslovom Začnimo od začetka vključujemo opise osnovnih pojmov iz sveta računalništva. Ključen vsebinski vidik spletne knjige je, da vsebuje poljudne opise pojmov. Soustvarjalce tako naprošamo, da pišejo kratke opise v preprostem jeziku. Strokovno zahtevnejše zapise lahko vključujejo v Wikipedijo, za zahtevnejše bralce spletne knjige pa pri opisih dodajo povezave na zunanje vire.

Struktura spletne knjige

Spletna knjiga je postavljena v wiki okolju in nudi uporabo klasičnih wiki strukturnih orodji, kot so povezave v tekstu, kategorije ipd. Ker nagovarjamo tudi posameznike, ki se soočajo s težavami razumevanja osnovnih pojmov, pa smo se odločili, da vsebino zastavimo tudi kot knjigo, skozi katero se lahko premikaš od strani do strani, torej z listanjem. Zato smo strani kategorij posameznih poglavji nadgradili s klasičnim vsebinskim kazalom. Osnovno vodilo pri sestavljanju spletne knjige je, da se vsak strokovni pojem obrazloži na svoji strani, ki se ga uvrsti v primerno poglavje in znotraj tega na primerno "stran" knjige.

Struktura vsebinskih strani

Naslov strani je pojem, ki bo na strani opisan (npr. Datoteka).
Ob prvem zapisu pojma v opisu, praviloma v oklepaju zapišemo angleški termin. Na primer: Datoteka (ang. File) je ...
Druge pojme, ki jih pri zapisu opisa naslovnega pojma uporabimo, s povezavo povežemo na stran tega pojma. Tako povezavo uporabimo le pri prvi uporabi tega pojma. Npr. Poznamo več vrst datotek, ki jih ločimo glede na njihovo končnico (vključena je povezava). Končnica (povezava ni vključena) je kratek tekst, pogosto sestavljen iz treh črk, ki se nahaja v imenu datoteke in stoji za piko.
Pod opisom pojma povezavi na prejšnjo in na naslednjo stran spletne knjige.
Nato pa sledijo še viri, ki smo jih uporabili pri pisanju besedila na tej spletni strani. Med vire je priporočljivo dodati povezavo na Wikipedijo v slovenskem in angleškem jeziku.
Čisto na dnu strani dodamo povezavo na kategorije, v katere posamezna spletna stran sodi.

Dolžina besedila na eni strani

Opis gesla naj bo kratek. Raje oblikujemo več krajših zapisov (več strani), kot pa enega daljšega. Vodilo naj bo, da se povezavi na prejšnjo in naslednjo stran na ekranu vidi, ne da bi se bilo treba premikati po 17-inčnem ekranu navzdol. "Skrolanju" se sicer ne bomo mogli izognit v primeru branja na telefonu. V posameznem opisu se osredotočamo le na to geslo samo. Kakor hitro se nam v opis zapiše nek drug strokovni pojem, razmislimo o tem, da bi ga predstavili na ločeni, svoji strani (npr. Vrste datotek, Končnice datotek, Format datoteke). V opisu besedila praviloma torej ni potrebe po oblikovanju wiki poglavji znotraj posamezne strani. Po drugi strani pa namen te spletne knjige ni sestaviti knjige definicij, slovarja ali leksikona.

Oblikovanje besedila

Oblikovanje besedila se nanaša na opis pojma, ki ga na njegovi strani opišemo. Besedilo oblikujemo v smiselne odstavke.
Povezave, ki jih vključujemo v besedilo, se navezujejo izključno na druge strani te wiki. V besedilo ne dodajamo povezav na zunanje vire, ti imajo svoje mesto v seznamu virov.
Uporabimo lahko poudarjeno besedilo (krepko ali bold), poševno besedilo (italic). Spreminjanje velikost besedila (velikost črk) uporabljamo res izjemoma.
Na voljo so tudi

  • oznake za naštevanje ali za
  1. številčenje.

Poljudnost besedila

Zapisati poljudno besedilo pomeni, da v zapisu uporabljamo kolikor mogoče splošno razumljene pojme, besede in besedne zveze. Pomeni tudi, da je besedilo pisano v sproščenem besedilnem slogu ali stilu.
Besedila v tej spletni knjigi torej ne sodijo med strokovna besedila, čeprav opisujejo strokovne pojme. Tudi ne moremo reči, da so poljudnoznanstvena, saj je za slednja značilno, da obdelajo neko temo za bralce, ki jih področje sicer zanima in so vsaj nekoliko že domači s tematiko. Tudi definicije ali slovarski in leksikološki zapisi so bolj strokovni kot poljudni zapisi.
Pri vsakem zapisu v spletni knjigi opravimo razmislek o tem, kako razumljivo je osebam, ki jih področje računalništva, informatike, digitalizacije ipd. niti ne zanima in potrebujejo le preprosto razlago, kaj nekaj pomeni. Nagovarjamo jih kot uporabnike, ki potrebujejo informacije o uporabniškem vidiku in ne o tem, kako je nekaj strokovno pravilno. Torej uporabnike, ki naj jih besedilo zadovolji s preprosto razlago. Večja bo razumljivost posameznih zapisov, večja bo verjetnost, da bo bralec nadaljeval z branjem oziroma se vračal k branju. Vsaka beseda, ki bralcu ni razumljiva, ga odvrne od nadaljnjega branja, posebej, če za branje ni posebej motiviran.
Pri tovrstnih besedilih je seveda poseben izziv zapisati tako, da bo zapis in sporočilo tudi pravilno. Torej, da ne bo vseboval napak in neresnic, a na ravni poljudnega in ne strokovnega zapisa. Nek stavek je lahko strokovno napačen, a za razumevanje s strani uporabnika dovolj pravilen. Naša ciljna skupina tudi niso bodoči strokovnjaki. Pomagamo si lahko s primerjavami in z besednimi zvezami "lahko bi rekli", "v osnovi to pomeni", "poenostavljeno rečeno" ipd. Smiselna je tudi uporaba preprostih primerov.

Primer

Besedilo kopirano in slovenske Wikipedije:
Datotéka (angleško file) je skupina podatkov v operacijskem sistemu, ki predstavlja zaključeno celoto. Običajno se nahaja na trdem/optičnem disku ali na magnetnem traku. Datoteka ima sebi lastno ime, lastnika, atribute. Glede na vsebino je programska ali podatkovna datoteka. Ena od skupin podatkovnih datotek so besedilne datoteke, v njih so shranjena besedila, praviloma z ukaznimi znaki za urejeni izpis. Vse datoteke so shranjene v dvojiški obliki. Datoteke so v operacijskem sistemu organizirane v mape (tudi direktorije).

Primer zapisa za spletno knjigo:
Datoteka (ang. File) je skupek podatkov ali informacij, ki smo ga s pomočjo nekega programa shranili za kasnejšo uporabo. Datoteke so lahko programske ali podatkovne. Programske datoteke oblikujejo programerji pri oblikovanju programa. Podatkovne datoteke pa ustvarjamo uporabniki programov. Datoteka ima svoje ime in končnico. Končnica datoteke je odvisna od programa, v katerem smo datoteko ustvarili. Ime datoteke pa oseba, ki datoteko ustvarja, pri tem sama določi. Ko datoteko ustvarimo, jo vedno tudi shranimo na točno določeno mesto oziroma mapo. Shranjeno datoteko vedno lahko odpremo s programom, v katerem je bila ustvarjena. Nekatere datoteke lahko odpremo tudi z drugimi programi.
Primer ustvarjanja besedilne datoteke:
Na spletu ste našli recept, ki ga želite shraniti na svoj računalnik za kasnejšo uporabo. Na računalniku odprete program za urejanje besedil, kot je na primer Libreoffice Writer. Odpre se vam nova datoteka, ki ji pravimo besedilna datoteka. Besedilo na spletni strani kopiramo in ga prilepimo v odprto datoteko. Izberemo funkcijo "Shrani kot", vpišemo želeno ime datoteke in izberemo mapo, v katero bomo datoteko shranili. V programu Libreoffice Writer lahko tudi izberemo vrsto datoteke oziroma njeno končnico, saj imamo na izbiro več možnosti. Priporočamo uporabo končnice ".odt". To je končnica, ki omogoča, da bo vašo datoteko lahko odrl vsak program, ki je namenjen urejanju besedil.

Vzorčna stran s pojasnili

Na strani