Teknisen kirjoittamisen resurssit

Tälle sivulle on koottu yhteenveto teknisen kirjoittamisen lisäresursseista.

Toimitukselliset tyylioppaat

Toimituksellisessa tyylioppaassa määritellään toimituksellisen työryhmän viestintäohjeet. Esimerkiksi, mikä seuraavista säännöistä organisaatiosi tulisi ottaa käyttöön otsikoiden osalta?

• Sijoittakaa otsikot lauseenalkuiseen isoon alkukirjaimeen (suuraakkosella kirjoitetaan vain kunkin otsikon ensimmäinen sana)
• Sijoittakaa otsikot otsikonalkuiseen isoon alkukirjaimeen (suuraakkosella kirjoitetaan suurin osa kunkin otsikon sanoista)

Älkää tuhlatko aikaanne ja energiaanne kiistelemällä tämäntyyppisistä kysymyksistä.Pyydä sen sijaan vain organisaatiotasi ottamaan käyttöön tietty toimituksellinen tyyliopas.Toimituksellinen tyyliopas tarjoaa vastauksia kysymyksiin, jotka koskevat kirjoitusvalintoja. Sillä ei ole merkitystä, että yhdessä toimituksellisessa tyylioppaassa suositellaan lauseen oikeinkirjoitusasua ja toisessa otsikon oikeinkirjoitusasua. On vain tärkeää, että organisaatiosi ottaa käyttöön yhden toimituksellisen tyylioppaan.

Mutta mikä toimituksellinen tyyliopas?Saatat jo tuntea yleiskäyttöiset toimitukselliset tyylioppaat (kuten Chicago Manual ofStyle tai University of Oxford StyleGuide).Insinööritiimisi tulisi kuitenkin käyttää tekniseen kirjoittamiseen erikoistunutta toimituksellista tyyliopasta. Suosittelemme valitsemaanjommankumman seuraavista:

• Googlen kehittäjadokumentaation tyyliopas tarjoaa toimituksellisia ohjeita kaikille, jotka kirjoittavat kehittäjadokumentaatiota Googleen liittyviin projekteihin.
• Microsoftin kirjoittamisen tyyliopas tarjoaa ohjeita kaikille, jotka kirjoittavat teknistä dokumentaatiota.

Ei kannata kirjoittaa omaa toimituksellista tyyliopasta. ”Oman” toimituksellisen tyylioppaan luominen ja ylläpitäminen vaatii valtavasti resursseja ja aiheuttaa valtavia ristiriitoja. Tästä huolimatta jotkut organisaatiot keksivät uutta terminologiaa, jota ei esiinny olemassa olevassa toimituksellisessa tyylioppaassa. Tällöin organisaatio voi tehdä jommankumman seuraavista:

• Pyytää toimituksellisen tyylioppaan ylläpitäjiä lisäämään uudet termit.
• Luo ja ylläpidä omaa käyttöopasta tai tyylilomaketta, jossa kodifioidaan organisaation erikoissanaston oikeinkirjoitukset ja sanojen käyttötavat.

Avoimen lähdekoodin dokumentointimahdollisuudet

.