# WIP: Documentation

Work in progress

This document is still under development.

Documentation is an important part of a well designed software. Based on Writing Great Documentation (opens new window) by Jacob Kaplan-Moss, and the documentation system by Divio (opens new window), we should cover following document types:

  • Introduction
  • Tutorials
  • How-to guides
  • Explanation (overview)
  • Reference
  • Release notes
  • Announcements (like release notes but on a single topic)
  • Case studies
  • Contribution guide
  • https://news.ycombinator.com/item?id=26002656