Chapter 11 is done, or the tale of meta documentation
Here it the table of content:
- Writing the Getting Started Guide
- Create Low Hanging Fruits
- The User Guide
- Documenting the Language Syntax
- The Language Reference
- Debugging for business users
- Creating developer documentation
- Outlining DSL structure
- The syntax implementation
- External Integration
- Documenting AST transformations
- Executable documentation
The chapter starts with...
Documentation is a task that most developers strongly dislike. It is treated as a tedious, annoying task and often falls on the developer who protests the least. One additional problem is that a developer trying to document his own work is often not going to do a good work.
This is not an aspiration against developers in general; the problem is that there are too many things that people who actually write the code takes for granted. And even in we ignore that, developers tend to write to developers, in a way that makes little sense to non developers.
That is true for me as well. And trying to document how developers should write documentation is... hard.
At least I can look forward for a really interesting Chapter 12.