The goal of the Docs Project is to create easy-to-follow, task-based documentation for Fedora Core users and developers. Other than the Installation Guide, each tutorial should be in DocBook XML article format, with one article per topic. This way, writers can contribute documentation about a specific topic without having to worry about how it fits into a manual or how it flows with other topics.
The following tools are used:
DocBook XML v4.1
Custom XSLT stylesheets for both print and HTML versions
Custom scripts to generate PDF and HTML output (use xmlto
)
Emacs with PSGML mode (optional, but recommended)
Emacs with nXML mode (optional, but also recommended)
The purpose of this document is to explain the tools used by the Docs Project as well as to provide writing and tagging guidelines so that the documentation is consistent and easy-to-follow.