Session-L15

From Dev8D

Jump to: navigation, search

What makes Dexy so Sexy for creating beautiful code documentation?

Time:Wed 16th Feb 2011 14:00-14:15
Location:Lightning Talks
Session type:Lightning Session - #dev8d #light

Maybe the reason programmers don't write enough documentation is that the

tools are awful. Wikis and blogging tools are great when you are using them for the type of writing they are intended for, but for documentation where you need to mix programming languages with the natural kind, they really aren't suitable. As a result, documenting code is usually a frustrating process that doesn't have the fun of writing code nor the satisfaction of writing prose. With Dexy, the integration of code and prose happens seamlessly and painlessly, so you can hack example scripts together and then write explanations using your favourite tools for each task and without ever losing your sense of flow. Dexy's literate approach means that it's easy to maintain your documentation over time, and its powerful and customizable filter system gives you tremendous control over how you present your code. Dexy also makes it easy to re-use your examples, for productivity as well as consistency across multiple types of documentation. Dexy works beautifully with version control systems and your favourite command line tools, and is a great, unobtrusive addition to any documentation or computational research workflow.

.