Dokumentointiohje

Lähettäkää kirjoitetut dokumenttien luvut sähköpostitse Anulle (akmaatta@cs.helsinki.fi). Teksimuotoisena käy hyvin, mutta otsikot ja oma nimi pääotsikon viereen olisi hyvä merkata seuraavan mallin mukaisesti.

Vien sitten kirjoitetut luvut tarkistuksen ja kuvien liittämisen jälkeen keskitetysti cvs:ään. Omia osuuksia saa päivittää cvs:n kautta suoraan.

Kuvia ei välttämättä tarvitse konvertoida ps-muotoon tai itse liittää dokumenttiin. Vaikka liittämiskoodi onkin esimerkissä, kuuluu kuvien liittäminen lähinnä dokkarivastaavan toimenkuvaan. Kuvan paikka ja tiedoston nimi kannattaisi kuitenkin merkitä ja kuvatekstit kirjoittaa. Konversiot teen Gimpillä, sille kelpaa aika moni grafiikkaformaatti, mm. png, gif, jpg, Photoshopin psd, Paint Shop Pron psp ja monet eksoottisemmat formaatit. Kuvat kannattaa lähettää näissä formaateissa. Kaaviokuvat kannattaa tallentaa gif-formaatissa; niissä ei tarvita kovin paljon värejä ja gif-kuvista tulee pienempiä kooltaan kuin jpg-formaatissa tallennetuista kuvista. Jos kuvia tekee Photoshopilla, voi psd-tiedoston lähettää konvertoitavaksi.

Malli

\section{Toimintasuunnitelma (Teemu)}

Ohjelmistotuotantoprojekti -kurssin laajuus on 6 opintoviikkoa. Täten 
jokainen ryhmäläinen käyttää...

\subsection{Työn ositus (Kaikki)}

% Kuvan liittämiskoodi: (% on kommenttimerkki)
\begin{figure}[ht] 
\centerline{\psfig{figure=prosessimalli.ps,height=10.7cm,angle=0}}
\caption{Prosessimalli} 
\label{prosessimalli} 
\end{figure} 

%Kuvaan viittaaminen tekstissä:
Projektimallina käytetään kuvan \ref{prosessimalli} mukaista modifioitua 
prosessimallia. Projekti jaetaan viiteen osaan seuraavasti. ...

%Lisää otsikkotasoja (tuli tarpeelliseksi osatehtäviin jaon takia)

/subsubsection{Opiskelijan käyttöliittymä opintokokonaisuuslomakkeessa}
% -> 3.2.2 Opiskelijan käyttöliittymä opintokokonaisuuslomakkeessa

(Esimerkki maarittelydokumentin rakenteesta)

% LEIPÄTEKSTI TAHAN VALIIN - eri luvut ovat omissa tiedostoissaan, 
% jotka on nimetty luvun otsikon mukaan. Input-komennolla liitetään
% erilliset tiedostot osaksi dokumenttia
 
\input{johdanto.tex}
\input{yleiskuvaus.tex}

% Nimetään tiedostot kappaleen otsikon ja eri osatehtävien mukaan
\input{vaatimukset_opintojentila.tex}
\input{vaatimukset_opintokokonaisuuslomake.tex}

\input{kayttotapaukset_opintojentila.tex}
\input{kayttotapaukset_opintokokonaisuuslomake.tex}

\section{Liittymät}
\input{liittymat_tietokanta.tex}
\input{liittymat_kali.tex}
 
\input{tekninen.tex}
\input{tietoturva.tex}
\input{kaytettavyys.tex}
\input{testaus.tex}

\input{rajoitteet_opintojentila.tex}
\input{rajoitteet_opintokokonaisuuslomake.tex}
 
% KUVIEN LIITTAMINEN - esim. psfig-pakkauksella, muitakin on
 
\begin{figure}[h]
\centerline{\psfig{figure=pm.ps,height=4.0cm,angle=0}}
\caption{OS3-projektin prosessimalli.} 
\label{prosessimalli} 
\end{figure}