Documentation: Single-Sourcing, Crowd-Sourcing And Other Voodoo
David Green (Tasktop ), Chris Aniszczyk (Red Hat, Inc. )
Making Community · Standard (25 mins)
Tuesday, 14:00, 25 minutes | Winchester
Tags: Build and Continuous Integration , Communication Docs/Education , Emerging Technology , Tools
David Green
Chris Aniszczyk
Is documentation an after-thought on your project? Is it painful to keep up to date? Establish a lightweight, collaborative process that encourages the maximum level of contribution from developers, writers and users. Learn how to eliminate technological barriers, publish to multiple formats and establish documentation best practices for your project.
This session will discuss the current state of documentation best-practices at Eclipse, then move into a step-by-step tutorial showing how to implement these best-practices using Mylyn WikiText, Ant and a wiki. Finally, you'll learn how to integrate this into your build process so that your product includes current documentation with every build.
David has been building tools on the Eclipse platform since 2004 and is an avid Mylyn user and evangelist. David is an Eclipse committer on Mylyn and most widely known for contributing WikiText. David's focus of the last 10 years has been applying MDD and MDE development techniques to the legacy modernization problem. He is also known for several other projects including Hudson Helper, an Android and iPhone application. David's opinions are regularly posted on his blog, greensopinion.blogspot.com.
Chris Aniszczyk is the co-lead of the Eclipse Plug-in Development Environment (PDE) project and a Senior Software Engineer at EclipseSource. He is the co-author of The Eclipse Rich Client Platform (Addison-Wesley) book. Chris tends to be all over the place inside the Eclipse community by committing on various Eclipse projects. He sits on the Eclipse Architecture Council, Eclipse Planning Council and has the honor to represent the committers on the Eclipse Foundation's Board of Directors. Chris’s passions are modularity, blogging, tooling and anything Eclipse. He’s always available to discuss opensource or Eclipse over a frosty beverage.