| Gentoo-Wiki menetti kaikki tietonsa äskettäin; tämä on uudelleen kirjoitettu, vielä keskeneräinen versio sivustosta. Katso Etusivu jos haluat auttaa sivuston uudelleen luomisessa. Artikkelien muokkaus ja luominen on toistaiseksi rajoitettu rekisteröityneisiin käyttäjiin. |
Gentoo Linux Wiki:Tyyliopas
Gentoo Linux Wiki
Gentoo Wikin artikkelit ovat suurimmalta osin "howto" -ohjeita liittyen ohjelmistojen tai laitteistojen asentamiseen, konfiguroimiseen ja niiden käyttämiseen.
Sisällysluettelo |
[muokkaa] Kielen tyyli
Artikkelit tulisi olla kirjoitettu suomen kielellä ja välttää teknisiä termejä kun mahdollista. Jos teknisiä termejä käytetään, ne tulisi selittää joko suoraan tai antamalla linkki sopiviin artikkeleihin tai sivuihin.
Artikkelit tulisi olla kirjoitettu kolmannesta persoonasta; kirjoittajan ei tulisi viitata itseensä ("minä").
[muokkaa] Sivun tyyli
Artikkelien tulisi olla yksinkertaisia, käyttäen wikin kuvauskieltä tarvittaessa. Wikin tarkoitus on antaa ohjeita, ei näyttää kauniilta. Kuvia ei tulisi käyttää sivujen koristelemiseen.
[muokkaa] Muoto
Artikkelien tulisi sisltää ainakin seruaavat asiat, tässä järjestyksessä.
- Aloita artikkelin aiheen tiivistelmällä
- Kerro, mitä käyttäjä saavuttaa seuraamalla artikkelia. Kerro myös mahdolliset riippuvuudet (ohjelmistot, laitteistot, tietämys...). Voit myös mainita osittain asiaan liittyviä aiheita joita artikkeli ei suoranaisesti sisällä ja linkit mistä löytää tietoa ko. aiheesta.
- Ohjaa käyttäjä prosessin läpi askel kerrallaan selittäen mitä komennet tekevät, varsinkin silloin kun se ei välttämättä ole päivänselvää.
- Liitä mukaan ongelmanratkaisuosio jos tarpeellista - tämä osio voi sisältää yleisiä ongelmia tai virheitä joita käyttäjä voi kohdata, ja kuinka ratkaista ne.
- Listaa aiheeseen liittyviä artikkeleja vaikka ne olisi mainittu tekstissä jo aiemmin. Tämä lista voi sisältää artikkeleja myös muilta sivuilta.
[muokkaa] Laitteistoartikkelit
Laitteistoartikkelien tulisi sisältää seuraavanlaiset lisätiedot:
- Tarpeen vaatiessa komentojen "lspci -nn" tai "lsusb" sisältö, joka liittyy laitteeseen
- Muita nimiä joilla laite voidaan tuntea.
