mstratman / perldoc-presentation

Presentation on Documentation in Perl for YAPC::NA 2011

Home Page:http://mstratman.github.com/perldoc-presentation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Introduction to Perl: Documentation

This is a presentation introducing new Perl programmers to documentation in the Perl community.

You can get the latest version of this presentation at https://github.com/mstratman/perldoc-presentation

Scope and Purpose

The focus of this presentation is on the conventions, expectations, and common practices of writing documentation for Perl code.

It includes a brief introduction to POD (Perl's Plain Old Documentation format), and examples of POD throughout, but is not a POD tutorial. Rather this is a supplement to a POD tutorial or the perlpod documentation.

By the end of this presentation, the audience should feel comfortable creating, organizing, and editing documentation for their Perl software projects.

Acknowledgements

W3C - HTML Slidy

The software and page design used in this presentation. More information at http://www.w3.org/Talks/Tools/Slidy2/.

Author

Mark A. Stratman <stratman@gmail.com>

License and Copyright

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

About

Presentation on Documentation in Perl for YAPC::NA 2011

http://mstratman.github.com/perldoc-presentation


Languages

Language:JavaScript 92.6%Language:Perl 7.4%