Ohjeet: Keskustelun ohjeet

Ohjelmointiputkan keskustelualue on tarkoitettu pääasiassa ohjelmointiaiheisille viesteille, mutta muistakin aiheista voi keskustella yleisessä keskustelussa. Keskusteluun ovat tervetulleita kaikki ohjelmoinnista kiinnostuneet iästä, taustasta ja ohjelmointitaidosta riippumatta. Muiden keskustelijoiden kunnioittaminen, kannustaminen ja opastaminen luovat hyvän keskusteluilmapiirin.

Ennen uuden keskustelun avaamista on hyvä tarkistaa, onko Ohjelmointiputkassa aikaisemmin keskusteltu samasta asiasta. Sivun oikeassa ylänurkassa olevalla hakukoneella voit etsiä yhtä aikaa vanhoista keskusteluista, koodivinkeistä ja oppaista. Kannattaa myös kokeilla Google-hakua.

Otsikon valinta

Kun aloitat keskustelun, valitse sille kunnollinen otsikko, josta ilmenee heti keskustelun aihe. Näin viestisi ei huku muiden samanlaisten sekaan. Esimerkiksi "Ongelma" on huono otsikko, sillä ongelmia voi olla niin monenlaisia. Tarkempi otsikko "Pokerivastustajan tekoäly" kertoo jo paljon enemmän. Älä vaihda asiaa kesken keskustelun; jos haluat keskustella jostain muusta, aloita uusi keskustelu uudella otsikolla.

Viestin kirjoittaminen

Kiinnitä huomiota viestin kieliasuun. Kirjoita viesti niin selvästi, että sen ymmärtää heti ensi lukemalla. Lukemista helpottavat isot alkukirjaimet, välimerkit, kappalejako ja kooditagit. Voit lainata muiden käyttäjien tekstiä lainaustagien avulla. Pyri lainaamaan vain olennaiset osat; tekstin turha kopioiminen vaikeuttaa keskustelun lukemista jälkikäteen.

Keskustelun hyvät tavat

Kun esität kysymyksen, kuvaile ongelma huolellisesti ja tarpeeksi kattavasti. Kerro esimerkiksi, mitä teet, miksi ja miten ja mikä siinä epäonnistuu. Jos sinulla on jo koodia, jossa epäilet vian olevan, liitä viestiin tarvittava osa koodista ja mahdolliset virheilmoitukset. Älä aloita keskusteluja mielipideaiheista kuten ”mikä on paras kieli” vaan rajaa kysymykset johonkin selvään ratkaistavaan asiaan kuten ”sopiiko kieli X asian Y tekemiseen”.

Jos toisen viesti on epäselvä tai huonosti perusteltu, pyydä tarkennuksia. Vastaa toisten tarkennuspyyntöihin asiallisesti ja huolellisesti. Toisen viestin, erityisesti tarkentavan kysymyksen sivuuttaminen on epäkohteliasta.

Kirjoita asia viestiin, käytä linkkejä vain syventävän lisätiedon tarjoamiseen. Kirjoita viestit ja koodit itse, älä kopioi muualta, älä tee tekoälyllä. Älä myöskään linkitä tekoälyn tuottamaan tekstiin tai hakukoneisiin vaan alkuperäisiin lähteisiin. Perustele kantasi yksilöidysti, itse ja omin sanoin. Jos viestisi on ristiriidassa aiempien viestiesi kanssa (esimerkiksi mielipiteesi tai tavoitteesi on muuttunut), mainitse tämä ja kerro syy tähän.

Suhtaudu nöyrästi ja kunnioittavasti keskustelussa saamiisi ohjeisiin ja neuvoihin, koska yleensä kysymykseen vastaaja tietää asiasta enemmän kuin kysyjä. Jos olet eri mieltä vastaajan kanssa, perehdy asiaan huolellisesti ja esitä täsmällisiä perusteluja mielipiteesi tueksi. Usein ehdotettua ratkaisua kannattaa myös kokeilla käytännössä. Hyvä vastaus voi sisältää valmiin ratkaisun sijasta myös rakentavia neuvoja, miten ratkaisun voi löytää itse.

Jokaisen keskustelijan tulee noudattaa näitä ohjeita. Toisten toimintaa valvovat siihen erikseen nimetyt käyttäjät. Älä siis huomauta toisille ohjeiden noudattamisesta vaan näytä siinä itse esimerkkiä.

Joskus keskustelun ohjeiden noudattaminen voi tuntua vaikealta, jolloin kannattaa pitää pari päivää taukoa keskustelusta ja keskittyä sen sijaan ohjelmointiin.

Kooditagit

Kun liität viestiin koodia, kirjoita sen ympärille kooditagit. Silloin kaikki merkit ovat yhtä leveitä ja sisennykset eivät katoa.

Merkitse kooditagiin myös kieli, jolloin koodin avainsanat väritetään automaattisesti, jos kieli on tunnettu. Muun muassa seuraavat väritykset ovat jo olemassa: C, C++, C#, CSS, EppaBasic, Go, HTML, Java, JavaScript, Limbo, Lua, Pascal, Perl, PHP, Python, QBasic, SQL, VB6, VBA, VB.NET. Uusia värityksiä lisätään tarpeen mukaan, joten muitakin nimiä tai lyhenteitä voi käyttää.

Esimerkkejä:

[koodi]Morjens![/koodi]

Morjens!

[koodi C++]
#include <stdio.h>
int main(void) {
    printf("Morjens!");
}
[/koodi]

#include <stdio.h>
int main(void) {
    printf("Morjens!");
}

[koodi PHP]
if (true) {
  echo "Morjens!";
}
[/koodi]

if (true) {
  echo "Morjens!";
}

Muut muotoilukeinot

Voit käyttää viesteissä seuraavia muotoilumerkintöjä:

auki: [h], kiinni: [/h]

https://www.ohjelmointiputka.net/

[linkki "https://www.php.net/"]PHP[/linkki]

[lainaus "Käyttäjä"]
Mitä mieltä olette?
[/lainaus]

[t]teksti[/t]

[b]käytä[/b]

[i]säästeliäästi[/i]

2[sup]3[/sup] = 8

H[sub]2[/sub]O

[ul]
[li]apina
[li]banaani
[/ul]