Chapter 14. Writing Documentation

Table of Contents

Plain Text
Perl's Plain Old Documentation: maintaining manpages
Docbook XML: Reference Books and Extensive User Manuals
UML Diagrams
UML Editing
Diagram Types

Documentation which comes with the Lire tarball is maintained in


Google

four formats: plain text, Perl POD, DocBook XML and UML diagrams. We'll talk about all four of these here.

Plain Text

Small files like README, NEWS, AUTHORS, doc/BUGS, and doc/TODO are traditionally maintained in plain text format. We adhere to this