Keskustelu: Yleinen keskustelu: Koodaajien tekemät ohjeet

Kuuluuko ohjelmoinnin kouluttautumiseen myös yksityiskohtia, miten tehdään softien käyttäjille niiden asennus- ja säätöohjeita. Vai jääkö se jokaisen ns. maalaisjärjen varaan. Törmäsin omakohtaiseen mielestäni asian havainnollistavaan esimerkkiin:

Kyseessä WP lisäke. Tässä on lisäkkeen asennusohje (Installation Instructions):
http://lesterchan.net/wordpress/readme/wp-print.html

Ja tässä on lisäkkeen säädöstä (Upgrade Instructions):
http://lesterchan.net/wordpress/readme/wp-print.html

Erityisesti Upgradessa käsitellään kohtia 1.2.3 jne asioita epäselkeästi. Eikö kohdassa 1 pitäisi käsitellä KAIKKI sitä koskevat asiat ja toimenpiteet. Kohdassa 2 sitten taas vain sitä koskevat jne

Eikö asennuksessa pitäis olla koko asennus ja upgradessa softan säätö?

Tekijä on osaava koodaaja, mutta muunlainen osaamattomuus tulee esille mm. hänen softiensa tukifoorumin käytössä. Siellä on ylimitoitetut turvajärjestelyt, mm. rekisteröityneen ja kirjautuneen jäsenen pitää vastata KOLMEEN turvakysymykseen, ennen kuin postaus lähtee. Kuka silloin viitsii vastailla foorumissa kysymyksiin?

Bonuskysymys mulla olisi, miten tämä lisäke sitten oikein asennetaan? :-)

Neptun kirjoitti:

Bonuskysymys mulla olisi, miten tämä lisäke sitten oikein asennetaan? :-)

Nopeasti lukaistuna pasteamastasi linkistä:

1. Siirry ftp-softalla wordpressin wp-content/plugins -hakemistoon
2. Kopioi kyseisen plugarin wp-print -hakemisto sisältöineen tuohon hakemistoon
3. Kirjaudu Wordpressin ylläpitopuolelle, siirry plugariosioon, ja aktivoi WP-Print Plugini.
4. Päivitä wordpressin hakukone-urlit: ( Settings -> Permalinks -> Save Changes )
5. Magic!

Neptun kirjoitti:

Erityisesti Upgradessa käsitellään kohtia 1.2.3 jne asioita epäselkeästi.

En tajua miten Upgraden 1, 2 ja 3 kohdat olisivat yhtään epäselvät kenellekään, varsinkin kun ne on noinkin yksinkertaiset.

(1.) Plugari otetaan ylläpitopuolelta pois päältä, (2. ja 3.) tiedostot kopioidaan mainittuun hakemistoon, ja jos vanhassa plugarista (4.) on jäänyt vanhentunut print-hakemisto, niin se poistetaan turhana.

Omasta opinahjosta: Ei noista mitään erityistä kurssia ole. Projektin sisäistä dokumentointia kyllä harjoitellaan, ja jos käyttötapauskuvaukset ovat kirjoitettu hyvin, niitä voidaan käyttää helposti käyttäjädokumentaation tekemisessä. Viestinnän kursseilla (ja ehkä enemmän/viimeistään opparia tehdessä) kehitetään kirjoituksellisen ilmaisun taitoja. Se, miten hyvin nämä asiat sisäistää, on luonnollisesti hyvin yksilöllistä.

Neptun kirjoitti:

Kuuluuko ohjelmoinnin kouluttautumiseen myös yksityiskohtia, miten tehdään softien käyttäjille niiden asennus- ja säätöohjeita.

Ei. Ei siellä kyllä mitään muutakaan hyödyllistä opeteta.

Neptun kirjoitti:

Erityisesti Upgradessa käsitellään kohtia 1.2.3 jne asioita epäselkeästi.

Ei noissa meikäläisen insinöörimielelle mitään epäselvää ollu. Lebe80 ne jo avaskin.

Mut harvinaisen huonosti oli kyl toteutettu tuo sivu. Normaalien linkkien sijasta jotain JS-mössöä.

Kyllä lisäpalikoiden dokumenteissa voi aina edellyttää, että itse alustan käytöstä on alkeet hallussa. WordPress on vielä harvinaisen yksinkertainen systeemi käyttää peruskäyttäjänkin näkökulmasta.

OK, kiitos kaikille tiedoista ja Lebe80 ohjeen selvennyksestä. Siitä vielä ohjeiden esityksestä, että Lebe 80 esittää asiat selkeästi, mutta siinä alkuperäisessä ei niin ole. Eikö juuri noin pidä menetellä kun käytetään numerosysteemiä, mitä tehdään ensin ja sitten. Ja silloin esitetään kussakin kohdassa siihen kuuluvat asiat. Ei ainakaan niin, että asennusta varten pitää tehdä sellaista mitä sanotaan Ungradessa.

Minusta kannattaa koodaajan kiinnittää huomio siihen, että tällaisia WP-lisälkkeitä ja vastaavia käyttävät kuitenkin henkilöt, joita ei ole juurikaan koodaustietoja, tehdään vain kuten sanotaan.

Tulkoon tästä esimerkistä mainittua, että ao. tekijä on tehnyt suuren joukon prugareita jne opiskeluaikanaan. Nyttemmin valmistunut, eikä enää niitä tee. On tosin luvannut päivittää entisiä. Meikäläisen saa tällaiset asetelmat (ei enää aktiivi, huono tukifoorumi, huonot ohjeet) katsomaan myös muita vastaavia plugareita WPhen :-)

PS Tarkoitus ei ole moittia koodaadia. Päin vastoin enemmistö esim. WP plugareista on aivan erinomaisesti ohjeistettu. Mutta eikö ohjeistustakin ole hyvää ja vielä parempaa kuten lienee koodaustakin?

Lebe80:n teksti vastaa aivan suoraan Installation-kohdan sisältöä. Vastaavasti Upgrade-kohdassa ovat aivan oikeat päivitysohjeet – tosin päivitys tässä tapauksessa tarkoittaa, että poistetaan vanha versio ja asennetaan uusi. Myöskään en ymmärrä, millä perusteella sinusta pitäisi olla "upgradessa softan säätö", kun upgrade kuitenkin tarkoittaa päivittämistä ja säätö- eli käyttöohjeet löytyvät loogisemmasta paikasta eli usage-otsikon alta. Eli kyllä vika näyttää nyt olevan lukijassa eikä ohjeessa.

Sorry pojat, Neptunille tapahtui moka. Esimerkissäni Installationin kanssa yhteen pelaavan sivu ei olekaan Upgrade vaan Usage! Jota siis oli tarkoitus hiukan arvostella.

Linkistä siis aukenee Readme tiedosto. Sen hakemistolehdistä Installation ja USAGE, josta siis oli mulla kyse, ei Upgradesta, joka on ihan selvä.

http://lesterchan.net/wordpress/readme/wp-print.html

Pahoittelen, että en huomannut että linkityskään ei toimi suoraa ohjeen välilehdille, vaan ne täytyy erikseen avata.

Siis aivan selvästi vikaa oli lukijassa kun antoi vääriä tietoja ja linkkejä edelleen...

* Merri sets mode +Neptun compatibility

Usage

You can use this plugin in two ways.

1) Use on limited pages/posts only by typing [print_link] to the content of selected page/post.

2) Or on all pages of certain type by adding the following code to your template (at /wp-content/themes/<YOUR THEME NAME>/):

<?php if(function_exists('wp_print')) { print_link(); } ?>

The supported template pages: index.php, single.php, post.php, page.php or theloop.php

IMPORTANT! This code must be after:

<?php while (have_posts()) : the_post(); ?>

NOTE! print_link() takes two value parameters that let you define the text for printing a post, and the second is the text for printing a page. The default values are empty, ie. print_link('', '').

Mutta oikeasti on hyvä vaan lukea ohjeet läpi ennen kuin alkaa tehdä mitään. Sinänsä tuossa ohjeistuksessa kun ei ole mitään suurta vikaa, asiat tulee kyllä esille kunhan ei hätäile ja toimi ennen kuin tietää mitä on tekemässä. Itseäni eniten hämmensi print_link('', '') ja sekin vain johtui fontista. Tasalevyiset fontit ftw.

Kiitos Merri, uskon saavani sen nyt asennettua. Neuvosi lukea kaikki ohjeet läpi on hyvä ja tarpeellinen. Niinhän siinä esimerkin Installation sivuillakin sanotaan. Kyllä luinkin, on kaikki jopa printattunakin. Silti olen sitä mieltä, että oleelliset Installationin asit voisi olla Installation sivulla. Silloin se olisi mielestäni ei ainoastaan hyvä vaan juuri tuo vielä parempi.