Designing documentation

18 Oct 2012 - 12:57pm
3 years ago
2 replies
2557 reads

I'm working on creating documentation for a programming language and development environement. We're considering creating a wide variety of material including tutorials, reference material, inline documentation, videos, searchacle examples, et cetera.

There are two things I would love to hear from anybody:

1) Books/articles/anything you know of discussing design of documentation

2) Examples of awesome documentation that you know of. Even though I'm working on programming tools, I would love examples from any domain to get inspiration.



19 Oct 2012 - 1:21am
Daniel Gross

Perhaps Scala could be a good example:

there is also clojure, perhaps interesting in terms of its organization.

19 Oct 2012 - 4:17am
William Hudson

On a purely practical level, you might want to have a look at tools for creating online help. I haven't used it in about 10 years, but RoboHelp is still going strong and is now owned by Adobe -

It's main claim to fame is that it allows you to author just once for delivery on multiple channels.



Syndicate content Get the feed