Documentation

Good documentation—including installation guides, user guides, white papers, FAQs, and more—provides users a roadmap to using software and hardware. Our articles focus on giving open source project creators ways to improve the quality and usefulness of their documentation.

Markup lowdown: 4 markup languages every team should know

When I ended my Doc Dish article about why you should use a rendered language for documentation, I told you that selecting a language was a matter for another day. Well…

Docs or it didn't happen

Many words have been written on community building, engagement, and retention. The discussion around community management is alive and kicking, with articles and blog posts…

10 tips for better documentation

Last July, after a full week at OKFestival, I managed to find enough energy to attend the Write the Docs EU Berlin Unconference. I only managed to attend one day of the event…

What can DevOps do for your documentation?

In my last article about content strategy, we walked through the philosophical change that's happening around technical documentation, and discussed new and exciting ways to…

Continuous integration and delivery for documentation

How does OpenStack merge over 900 documentation changes in less than three months? We treat docs like code and continuously publish reviewed content from multiple git…

5 lessons from the Open Help doc sprints

Sprints are one of the most effective tools for building momentum and community around an open source documentation project. For the past four years, the Open Help Conference…

Subscribe to Documentation