Introduction to writing Perl Documentation

By JT Smith on March 28, 2012 3:00 AM

Mark A. Stratman will give a talk at YAPC::NA 2012 described as:

This talk will help get you in the mindset necessary to write effective documentation.

We will briefly touch on POD (Plain Old Documentation) syntax, but due to its elegant simplicity we can quickly move on to examine the bigger picture, and explore the decisions we face when writing documentation.

Some key points will include:

- Conventions and expectations

- APIs, Tutorials, Manuals, and Cookbooks… and how and when to use them.

- Writing POD to take full advantage of formatters (e.g. Pod::LaTeX, Pod::HTML)

- Inviting community contributions

[From the YAPC::NA Blog.]