Introduction to Perl: Documentation
By Mark A. Stratman (mstratman)
Date: Monday, 27 June 2011 16:15
Duration: 20 minutes
Target audience: Beginner
Language:
Tags: documentation perldoc pod
Download slides: http://is.gd/perldoc
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 why you should keep them separate.
- Writing POD to take full advantage of formatters (e.g. Pod::LaTeX, Pod::HTML)
- Inviting community contributions
- bill pemberton (akadl)
- Steven Novakovich
- Ed Deloye
- Chuck Bury
- Ali Nabavi (hourback)
- Robert Threet (RAT)
- Kevin Shaum
- Lawrence Hixson (Larry)
- Jess Robinson (castaway)
- Mike Weisenborn
- Marcus Del Greco
- Brendan Byrd (SineSwiper)
- Mary Ehlers
- Kevin Zembower
- Michelle Byrd (Seraphina)
- Greg Estep
- Fredrick Langston
- G. Wade Johnson (gwadej)
