DDP:n tehtävälista

Kiireelliset:

Armoton vanhojen dokumenttien karsinta.
Asetettava dokumentoinnin rakenteelle ehdot ja kirjattava ne. Yksinkertaistaen, tehtävä Dokumentoinnin menettelytavat-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 täältä mutta sitä täytyy korjailla vielä.
Lisättävä automatisoitu menetelmä käännösten hallitsemiseksi, samaan tapaan kuin www-sivuston WML-lähdekoodia hallitaan.
Päätettävä mitä tietoja CD:llä tulisi olla ja automatisoitava menetelmä jolla saadaan aikaiseksi kunnollinen indeksi. Asiaan liittyviä tietoja on täällä ja subversion-hakemistosta löytyy joitakin skriptejä joita täytyy hienosäätää ja lisätä cron-tehtäväksi.

Ideoita:

Seuraava on vain luettelo ideoista joita on tullut esille postilistallamme. Niinpä nämä saattavat olla hyviä ja huonoja ideoita. :-)

Tarjottava yhdenmukainen käyttöliittymä kaikille Debianin man-sivuille, niin kuin useat muut tekevät jo, esim. Ubuntu, FreeBSD, NetBSD, OpenBSD, HP (HPUX), IBM (AIX), SGI (Irix), ja Sun (Solaris). Merkillistä kyllä, on olemassa useita palvelimia (kuten Fifi) jotka jo tarjoavat kaikki Debianin man-sivut. Tästä on tehty vikailmoitus #264589.
Ensimmäinen beta-versio on osoitteessa manpages.debian.net.
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. doc-base voisi käyttää URN:ää viitatessaan dokumentteihin tiedostonimien käytön sijaan.
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:
- .deb-paketit olisivat pieniä
- paras joustavuus
- voisimme jopa muokata linkkejä dokumentteja käännettäessä, ts. korvaamalla Internet-linkit paikallisilla jos tällaiset tiedostot ovat olemassa !!!
- indeksi-sivun pitäminen ajanmukaisena on todennäköisesti helpompaa (dwww-tyyliin)
Havaitsemani haittapuolet:
- debiandoc-sgml täytyy olla asennettuna (ei kovin suuri haitta)
- dokumentin muodostaminen kestää hetken (ei liikaa mutta pelkkä paketin purku olisi nopeampaa)
doc-base voisi määritellä tällaisen järjestelmän perusteet, koska se seuraa dokumenttien metadataa.
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.
Luodaan www-sivuston tieto saatavilla olevista manuaaleista keräämällä ko. tiedot (jotka saadaan manual.defs- ja version.defs-datasta) automaattisesti CVS:stä.
Käännösten tilan seurannan mahdollistaminen CVS:n tietojen pohjalta. Harkittava debian-installerin kehittämän rakenteen hyödyntämistä asennusoppaassa.
Seurataan dokumentin “muutettu-viimeksi”-tilaa jotta saatavilla olevia dokumentteja selaavat käyttäjät voivat päätellä onko dokumentti heidän tavoittelemansa vai ei.
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).
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).
Käyttäjien käyttöön perusmallin vianseurantajärjestelmä dokumentoinnille. Tätä käytetään dokumenteille jotka on paketoitu (tosin kaikki eivät ole).