[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [ot] "meta" FAQ ? - wie schreibt man FAQs und HOWTOs?



On Tue, 2003-07-22 at 16:06, Ulrich Poeschl wrote: 
> hallo,
> 
> ich möchte ein kleines howto schreiben, in form von ein paar faq's oder
> so. wenn ich mir dann schon die arbeit mache, möchte ich das auch
> möglichst "RFC-konform" machen. :)
> 
> kennt jemand einen link oder so, für die wichtigsten richtlinien bei
> einem howto oder FAQs?

http://www.fokus.gmd.de/linux/dlhp/aktuell/DE-Autor-HOWTO.html und
allgemein http://www.tldp.org/

> ich denke unter anderem an folgendes:
> 
> strukturierung der informationen

linuxdoc
docbook - sgml/xml, sehr umfangreich und eher fuer groessere Dokumente
geeignet
debiandoc - besitzt einen im Vergleich zu docbook sehr eingeschraenkten
Umfang an Auszeichnungselementen und ist daher schnell zu erlernen
http://www.rosenthal.hanse.de/comp/wp/sgml/debiandoc/ 

> copyright
> lizenz

gpl oder http://de.wikipedia.org/wiki/GNU_Freie_Dokumentationslizenz

> disclaimer
> HTML, und txt-versionen

Für alle drei existieren Tools zur Konvertierung in die Ausgabeformat
txt, html, ps und pdf.

> management des dokumentes (gibts da software?)

rcs, cvs zur Versionskontrolle

Gruss

-- 
Peter Hoffmann <tosh@cs.tu-berlin.de>
http://cs.tu-berlin.de/~tosh



Reply to: