perché docbook è necessario?
Il formato DocBook è stato progettato dal consorzio OASIS specificamente per la documentazione tecnica. Fornisce un ricco insieme di tag per descrivere il contenuto del documento.
Di seguito sono riportati alcuni punti chiave che aiutano a comprendere che cosa sia DocBook:
- DocBook è un linguaggio di markup
È molto simile a HTML sotto questo aspetto. I tag danno una struttura al documento e appaiono mescolati al testo informativo.
Questo aspetto particolare rappresenta una rivoluzione per la traduzione della documentazione, poiché la fase di DTP (impaginazione del testo) viene eseguita una sola volta indirettamente attraverso l'etichettatura del testo originale. I traduttori devono solo tradurre "tra i tag" e con un singolo tasto viene generato l'output tradotto. - È realizzato per la documentazione tecnica
DocBook è perfettamente adatto alla documentazione delle parti di motori automobilistici. Tuttavia, è fortemente orientato verso la documentazione dei programmi per computer. - Tecnicamente, DocBook è un DTD SGML o XML
Ciò significa che è possibile sfruttare i numerosi strumenti consapevoli di SGML e XML. Sebbene DocBook come implementazione XML sia abbastanza recente, ha una lunga storia come implementazione SGML. - DocBook non è un linguaggio di presentazione
DocBook si preoccupa attentamente di non specificare come appaia la documentazione finale. Questo consente allo scrittore di concentrarsi sull'organizzazione e sul significato del documento che scrive. Tutti gli aspetti di presentazione sono demandati ai fogli di stile.
Questo garantisce che tutti i documenti abbiano un aspetto coerente, indipendentemente da chi sia il redattore tecnico. - DocBook è personalizzabile
È abbastanza facile personalizzare il DTD per soddisfare le proprie esigenze grazie alla sua organizzazione modulare. Tuttavia, è necessario essere consapevoli che ciò deve essere fatto nel rispetto delle convenzioni SGML/XML e potrebbe introdurre incompatibilità.
Se DocBook viene utilizzato in combinazione con i fogli di stile modulari di Norman Walsh, è anche possibile personalizzare il modo in cui un file DocBook può essere stampato o messo online. - DocBook è completo
Il gran numero di tag definiti in DocBook garantisce che possa adattarsi a un'ampia gamma di situazioni e aspettative di elaborazione.
Questo, a sua volta, lo rende un po' difficile da imparare, ma è possibile scrivere documentazione conoscendo solo un insieme limitato di tag e facendo riferimento alla documentazione di riferimento quando necessario.
Comments