[osiris-devel] Documentation Standard

Luke West luke at responsys.com
Wed Apr 7 05:17:42 EDT 2004


Sounds like a good idea.

Would this include user documentation as well?

L

-----Original Message-----
From: Thomas Jones [mailto:thomas.jones at linux-howtos.com] 
Sent: 06 April 2004 10:31
To: Osiris Developers
Subject: [osiris-devel] Documentation Standard


Hello all,

I would like to see that all future/current documentation be standardized.

More precisely this is what I propose:

1) Written in Docbook XML
2) Encoding theme = ISO-8859-1
3) DocumentType Definition = kdex.dtd - Standard KDE Documentation
4) Public ID = //KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN

This affords the project a great magnitude of capabilities to process ALL 
documents efficiently. We can generate almost any format docs upon 
completion. It is easily updated to new standards. Any future translation
can 
be done externally and applied with a simple argument.

This should provide the project with very nice, efficient documentation that

"mirror" the efforts of other Open Source projects. Thus giving the end-user

a more recognizable product.

Any ideas/comments?

Thomas

_______________________________________________
osiris-devel mailing list
osiris-devel at lists.shmoo.com
https://lists.shmoo.com/mailman/listinfo/osiris-devel



More information about the osiris-devel mailing list