Haskell has a stigma of having poor or no documentation at
all. Though more and more maintainers are doing a hell of a job to
improve the quality of their libraries and applications, it is still
not enough. We need to strengthen our vision of documentation
collectively and as a consequence, master the existing tools for
doing that.
There are different types of
documentation. Today we want to
talk about API and libraries documentation inside your library, and
accordingly about Haskell gear for that –
Haddock.
The blog post is going to give Haddock overview, suggest
documentation best practices, reveal the specialities of the Haddock
tool, and show-and-tell lots of different examples of how to squeeze
more out of your documentation. It should be interesting to library
maintainers, developers who want to improve their documenting skills
and everyone interested in documentation techniques in Haskell.