1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
#use wml::debian::ddp title="DDP:n tehtävälista"
#use wml::debian::translation-check translation="1.22"
<H3>Kiireelliset:</H3>
<ul>
<li>Armoton vanhojen dokumenttien karsinta.
<li>Asetettava dokumentoinnin rakenteelle ehdot ja kirjattava ne.
Yksinkertaistaen, tehtävä <a href="docpolicy">Dokumentoinnin
menettelytavat</a>-dokumentti valmiiksi, Debianin web-tiimin hyväksymänä
ja siunaamana. Tähän sisältyy www-sivuston ja pakettien
tiedostojen sijainnin johdonmukaistaminen. Luonnos on saatavilla <a
href="$(HOME)/doc/manuals/ddp-policy/ch-manuals#s3.5">
täältä</a> mutta sitä täytyy korjailla vielä.
<li>Lisättävä automatisoitu menetelmä käännösten hallitsemiseksi, samaan
tapaan kuin www-sivuston WML-lähdekoodia hallitaan.
<li>Päätettävä mitä tietoja CD:llä tulisi olla ja <em>automatisoitava</em>
menetelmä jolla saadaan aikaiseksi kunnollinen indeksi. Asiaan liittyviä
tietoja on <a
href="$(HOME)/doc/manuals/ddp-policy/ch-manuals#s3.6">
täällä</a> ja subversion-hakemistosta löytyy joitakin <a
href="http://anonscm.debian.org/viewvc/ddp/utils/scripts/">skriptejä</a> joita
täytyy hienosäätää ja lisätä cron-tehtäväksi.
</ul>
<H3>Ideoita:</H3>
<p>Seuraava on vain luettelo ideoista joita on tullut esille
postilistallamme. Niinpä nämä saattavat olla hyviä ja huonoja ideoita. :-)
<br>
<ul>
<li>
<p>Tarjottava yhdenmukainen käyttöliittymä kaikille Debianin man-sivuille,
niin kuin useat muut tekevät jo, esim.
<a href="http://manpages.ubuntu.com/">Ubuntu</a>,
<a href="http://www.freebsd.org/cgi/man.cgi">FreeBSD</a>,
<a href="http://man.netbsd.org/">NetBSD</a>,
<a href="http://www.openbsd.org/cgi-bin/man.cgi">OpenBSD</a>,
<a href="http://docs.hp.com/hpux/os/man_pages.html">HP (HPUX)</a>,
<a href="http://publib16.boulder.ibm.com/cgi-bin/ds_form?lang=en_US&viewset=AIX">IBM (AIX)</a>,
<a href="http://techpubs.sgi.com/library/tpl/cgi-bin/init.cgi">SGI (Irix)</a>,
ja
<a href="http://docs.sun.com/app/docs/doc/816-3930/intdoclist-tbl-343">Sun (Solaris)</a>.
Merkillistä kyllä, on olemassa useita palvelimia (kuten <a
href="http://www.fifi.org/cgi-bin/man2html">Fifi</a>) jotka jo tarjoavat
kaikki Debianin man-sivut.
Tästä on tehty vikailmoitus <a href="https://bugs.debian.org/264589">#264589</a>.
<p>Ensimmäinen beta-versio on osoitteessa <a
href="http://manpages.debian.net">manpages.debian.net</a>.
# Funny enough, not all Linux distributions provides an official source
# for online search of manpages. Not even Red Hat does this.
# And TLDP points to different unofficial sources including
# http://linux.ctyme.com/
# jfs
<li>URN:n käyttöönotto. Tämä mahdollistaisi käyttäjien tarkastella
dokumentteja paikallisesti, www-sivustolla tai peileillä. Paikallista
määrittelyä voisi käyttää ilmoittamaan lähemmästä tai sopivammasta
peilistä tai tilaamiseen. <tt>doc-base</tt> voisi käyttää URN:ää
viitatessaan dokumentteihin tiedostonimien käytön sijaan.
<li>Pohdiskelin mitkä tiedostomuodot sisällytämme debian-paketteihin
(.deb). Ainakin HTML-muotoiset (se on käytäntö) mutta jotkut saattavat
haluta myös PostScript- tai TEXT-versiot. Niinpä sain idean _pelkän_
SGML-lähdekoodin levityksestä ja käyttäjän haluamien formaattien
luomisesta käytön aikaisena (asennettaessa ja myöhemminkin). Tällä on
useita etuja:
<ul>
<li>.deb-paketit olisivat pieniä
<li>paras joustavuus
<li>voisimme jopa muokata linkkejä dokumentteja käännettäessä, ts.
korvaamalla Internet-linkit paikallisilla jos tällaiset
tiedostot ovat olemassa !!!
<li>indeksi-sivun pitäminen ajanmukaisena on todennäköisesti
helpompaa (dwww-tyyliin)
</ul>
Havaitsemani haittapuolet:
<ul>
<li>debiandoc-sgml täytyy olla asennettuna (ei kovin suuri haitta)
<li>dokumentin muodostaminen kestää hetken (ei liikaa mutta pelkkä
paketin purku olisi nopeampaa)
</ul>
<p><tt>doc-base</tt> voisi määritellä tällaisen järjestelmän perusteet,
koska se seuraa dokumenttien metadataa.
<li>Selvitettävä mitä dokumentteja käyttäjät lukevat (tai etsivät) jotta
voimme keskittyä niihin. Tätä ei ole vielä tutkittu. Joitakin tiedonlähteitä
voisivat olla käyttäjien postilista (kyselyn tekeminen), www-lokin
statistiikat (sekä pääsivuston että peilien) ja, koska dokumentteja
levitetään Debian-pakettien muodossa, popularity-contest-statistiikka.
<li>Luodaan www-sivuston tieto saatavilla olevista manuaaleista
keräämällä ko. tiedot (jotka saadaan <tt>manual.defs</tt>- ja
<tt>version.defs</tt>-datasta) automaattisesti CVS:stä.
<li>Käännösten tilan seurannan mahdollistaminen CVS:n tietojen pohjalta.
Harkittava debian-installerin kehittämän rakenteen hyödyntämistä
asennusoppaassa.
<li>Seurataan dokumentin “muutettu-viimeksi”-tilaa jotta
saatavilla olevia dokumentteja selaavat käyttäjät voivat päätellä onko
dokumentti heidän tavoittelemansa vai ei.
<li>Harkittava dokumentoinnin tarjoamista käyttäjille muillakin kielillä
kuin englanniksi (CVS sisältää hakemistoja muutamille kielille ja joitain
dokumentteja jotka on alun perin kirjoitettu jollain muulla kielellä kuin
englanniksi).
<li>Harkittava vuorovaikutteisen järjestelmän tarjoamista käyttäjille
dokumenttien kommentointiin wiki-tyyppisen käyttöliittymän kautta, joko
pääsivuston esitysmallista poiketen tai käyttäen samaa esitysmallia.
Dokumenttien kirjoittajat voisivat hyödyntää tätä palautetta ja, vaikkakin
avoin väärinkäytöksille, se on toiminut melko hyvin muiden
dokumentointiprojektien kohdalla (PHP).
<li>Käyttäjien käyttöön perusmallin vianseurantajärjestelmä dokumentoinnille.
Tätä käytetään dokumenteille jotka on paketoitu (tosin kaikki eivät ole).
</ul>
|
