NB: Het origineel is recenter dan de vertaling.

DDP TODO Lijst

Dringende TODO-lijst:

Meedogenloos muffe (verouderde) documentatie weghalen.
Stipuleer en documenteer een documenthiërarchie. Vervolledig het Documentatie Beleid-document, met de toestemming van het Debian Web team. Die eist consistentie van bestandslocatie op het web en in pakketten. Er is hier een kladversie aanwezig, maar het moet nog nagekeken worden.
Zorg voor een manier om vertalingen automatisch te beheren zoals het met de WML-bronnen van de website gebeurt.
Bepaal welke informatie op de CD moet komen en automatiseer de creatie van een correcte index. Relevante informatie vindt u hier en CVS heeft enkele scripts die opgekuist moeten worden en dan toegevoegd aan een cronjob.

Ideeën:

Het volgende is maar een lijst van ideeën die gesuggereerd zijn in verschillende threads op de mailinglijsten. Dus, het kunnen goede en slechte ideeën zijn. :-)

Zorg voor een consistente interface voor alle manpagina's van Debian, zoals vele andere het doen, bijvoorbeeld FreeBSD, NetBSD, OpenBSD, HP (HPUX), IBM (AIX), SGI (Irix), en Sun (Solaris). Curieus genoeg zijn er al verschillende servers (zoals Fifi) die alle manpagina's van Debian aanbieden. Dit is Bug #264589. Er was een eerste beta-versie op manpages.debian.net, maar deze is momenteel niet beschikbaar.
Implementeer URN's. Dit zou het voor gebruikers mogelijk maken om documentatie lokaal, op de website of op één van de spiegelservers te raadplegen. Lokale configuratie kan worden gebruikt om spiegelservers aan te geven die dichtbij of geschikter zijn of om te sorteren. doc-base kan URN's gebruiken om naar documenten eerder dan naar bestanden te verwijzen.
Ik dacht over welk uitvoerformaat we willen gebruiken in Debian-pakketten (.deb). We moeten HTML gebruiken (dat is het beleid), maar sommige mensen willen misschien PostScript- of TEKST-versies hebben. Dus had ik het idee van _enkel_ de SGML-broncode te gebruiken en de formaten die de gebruiker wilt aan te maken wanneer nodig (kan op het installatiemoment zijn of daarna). Dit heeft verschillende voordelen:
- de .deb's zouden klein zijn
- grootste flexibiliteit
- we kunnen zelfs de links aanpassen wanneer de documentatie wordt gegenereerd, v.b. Internetlinks vervangen door lokale links als de bestanden aanwezig zijn!!!
- het is waarschijnlijk gemakkelijker om een algemene indexpagina up-to-date te houden (a la dwww)
De nadelen die ik zie:
- mensen moeten debiandoc-sgml hebben geïnstalleerd (maar dat is niet groot)
- formatting zal enkele seconden duren (niet te veel, maar uitpakken alleen zou sneller zijn)
doc-base kan de basis van dit type systeem definiëren, want het houdt metadata bij voor documenten.
Bepaal welke documenten echt door onze gebruikers worden gebruikt (of gezocht) zodat we hierop kunnen focussen. Dit is iets dat nog niet is onderzocht. Mogelijke informatiebronnen zijn de gebruikersmailinglijst (doe een poll), de weblogstatistieken (van zowel de hoofdwebsite als de spiegelservers) en omdat documenten ook worden verspreid als Debian-pakketten de "popularity contest"-data.
Genereer de informatie over beschikbare handleidingen op de website door de informatie (die wordt aangeboden door manual.defs en version.defs) automatisch te uit CVS te halen.
Maak het mogelijk om de vertaaltoestand te volgen gebaseerd op informatie van de CVS-site. Overweeg om het voorbeeld ontwikkeld door de debian-installer te hergebruiken voor de installatiehandleiding.
Volg de toestand van het document 'last-changed' zodat de gebruikers die door de beschikbare documenten browsen kunnen afleiden of het document voor hun van toepassing is.
Overweeg om documentatie in talen verschillend van Engels aan te bieden voor gebruikers (CVS bevat mappen voor enkele talen en sommige documenten die oorspronkelijk niet zijn geschreven in het Engels)
Overweeg om een interactief mechanisme aan te bieden aan gebruikers om documenten te annoteren via een wiki-interface, gescheiden van de voorstelling op de website of gebruikmakend van dezelfde voorstelling. Deze feedback zou kunnen gebruikt worden door de auteur(s) van het document en, zelfs als het open staat voor misbruik, het werkt goed voor andere documentatieprojecten (PHP)
Zorg dat gebruikers een algemeen Bug Tracking Systeem gebruiken voor documentatie. Het wordt gebruikt voor deze documenten die een pakket aanbieden, maar niet alle documenten doen dit.