[osiris-devel] Documentation Standard

[Alexei_Roudnev]

I prefer to have a docs with a _good_ content, than to have a docs in  a
good format.
For now, docs are in a _sufficient_ format, but content is not perfect yet.
Changing format will not create any value, except if it simplify making
changes.

(It's not about development docs, which are reasonable to be in automated
format).

----- Original Message ----- 
From: "Luke West" <luke at responsys.com>
To: "'Osiris Developers'" <osiris-devel at lists.shmoo.com>
Sent: Wednesday, April 07, 2004 2:17 AM
Subject: RE: [osiris-devel] Documentation Standard


> 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
> _______________________________________________
> osiris-devel mailing list
> osiris-devel at lists.shmoo.com
> https://lists.shmoo.com/mailman/listinfo/osiris-devel
>