That is very encouraging. Is there any open standard DocBook
schema that
is suited for Hardware/Chip documentation? An open standard
may be
beneficial to everyone in the long run given that a very
large
percentage of chips share a common structure in the overall
hardware/software architecture and associated
documentation.
Regards,
Maneesh
Jirka Kosek wrote:
> Maneesh Soni wrote:
>
>> I would like to know if DocBook will be good for
hardware
>> documentation. While there are specified constructs
in DocBook for
>> software API documentation, there's does not seem
to be much to
>> support hardware specifics. For example, it is
unclear how, in
>> DocBook, one could document (and tag) the details
of the memory map
>> of an embedded processor in a chip or memory mapped
registers.
>>
>> Could someone on this list please let me know if
DocBook has been
>> used for hardware documentation and how effective a
solution is it
>> for the purpose?
>
> Very effective, but I suggest you to spend some time
with analysis. I
> have several customers from hardware and chip producing
companies.
> After initial analysis I created special customized
version of DocBook
> for them. Many elements from standard DocBook were
removed in orded to
> make editing easier and few new specific elements (like
register,
> instruction, signal, ...) were added. In DocBook V5.0
it is dumb easy
> to create your own customized version of DocBook. For
V4.x
> customization you need DTD geek 
>
------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-unsubscribe lists.oasis-open.org
For additional commands, e-mail: docbook-helplists.oasis-open.org
|