Chapter 11. DSLs and documentation
In this chapter
- Essential documentation for your DSL
- Writing the user guide
- Documenting the language syntax
- Creating an implementation guide
Documentation is a task that most developers strongly dislike. It’s treated as a tedious, annoying chore, and it often falls to the developer who protests the least. Furthermore, developers trying to document their own work often don’t do a good job. There are too many things they take for granted in their own code, and they tend to write to developers, in a way that makes little sense to non-developers.
At least, that’s what I say when I’m asked to write documentation. It doesn’t usually get me out of the task, but the problems are real.
Solid documentation is ...
Get DSLs in Boo now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
