Istraživački dojo‎ > ‎Skladište‎ > ‎

Upute za pisanje dokumentacije

Pošto neki komad opreme nije nužno očit za korištenje općenito vodimo dokumentaciju kako bi netko drugi mogao koristiti taj komad opreme jednom kad mi sami shvatimo kako ga koristiti. Ako neki komad opreme nije dokumentiran pokušajte ga koristiti i napišite kako da to mogu i drugi :)

Dokumentaciju za pojedini komad opreme dodajete kao novu stranicu pod /dojo/skladiste
Kada dođete na glavnu stranicu skladišta napravite novu stranicu i pod opcijama za predložak (Choose a template / Odaberite predložak) odaberite "Predložak za skladištenje" i unesite naslov (po uputi dolje). Predložak će automatski staviti osnovnu strukturu koju imate opisanu u nastavku.

Svaki komad dokumentacije treba imati:
  1. Naslov - treba biti jasno o čemu se radi, pogotovo s tim što naslov postaje URL do dokumenta
  2. Kratki opis - opišite što je to u naslovu i čemu uopće služi
  3. Dnevnik - kratka bilješka s datumom svaki put kad imate neki značajniji napredak ili ste npr. koristili taj komad opreme u nekom konkretnom projektu
  4. Kako koristiti - detaljni opis korištenja opreme sa popratnim materijalima
Comments