Защо е необходим DocBook?
Форматът DocBook беше проектиран от консорциума OASIS специално за техническа документация. Той предоставя богат набор от тагове за описание на съдържанието на вашия документ.
Ето няколко ключови точки, които помагат да разберете какво представлява DocBook:
- DocBook е маркиращ език
В това отношение той е много подобен на HTML. Таговете придават някаква структура на вашия документ и се появяват смесени с информационния текст.
Тази специфична особеност го превръща в революция по отношение на превода на документация, тъй като фазата на DTP (оформянето на текста да изглежда добре) се извършва веднъж завинаги косвено чрез тагването на оригиналния текст. Преводачите трябва само да превеждат „между таговете“ и с натискането на един клавиш се генерира преведеният изход. - Създаден е за техническа документация
DocBook е отлично подходящ за документация на части за автомобилни двигатели. Въпреки това, той е силно ориентиран към документация на компютърни програми. - Технически погледнато, DocBook е SGML или XML DTD
Това означава, че човек може да се възползва от многото инструменти, поддържащи SGML и XML. Макар че DocBook като XML реализация е сравнително нов, той има дълга история като SGML реализация. - DocBook не е език за представяне
DocBook внимателно се грижи да не уточнява как ще изглежда крайната документация. Това позволява на автора да се съсредоточи върху организацията и смисъла на документа, който пише. Всички въпроси, свързани с представянето, са прехвърлени към стиловите таблици.
Това гарантира, че всички ваши документи имат последователен вид, независимо кой е техническият автор. - DocBook е персонализируем
Доста лесно е да се персонализира DTD, за да отговаря на нуждите на даден потребител, благодарение на модулната му организация. Но трябва да се има предвид, че това трябва да се прави при спазване на конвенциите на SGML/XML и че може да въведе несъвместимости.
Ако DocBook се използва заедно с модулните стилови таблици на Norman Walsh, също така е възможно да се персонализира начинът, по който DocBook файлът може да бъде отпечатан или публикуван онлайн. - DocBook е изчерпателен
Големият брой тагове, дефинирани в DocBook, гарантира, че той може да обслужи широк спектър от ситуации и очаквания за обработка.
Това от своя страна го прави малко труден за научаване, но човек може да се справи с писането на документация, познавайки само ограничен набор от тагове и прибягвайки до справочната документация при нужда.
Comments