Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

List of documentation types with references

Jump to bottom
Cameron Shorter edited this page Apr 10, 2020 · 2 revisions

This is a brain dump doc of all the possible open source project documentation types

To contribute, please add your documentation type in alphabetical order. If you can, include a short description (short = < 1 line) or a link to an example.

  • API spec (OpenAPI or other type)

  • API reference documentation (interactive or static)

  • Application administration guide (desktop, server, browser extension)

  • Application installation documentation (desktop, server, browser extension)

  • Application developers' guide (development processes, build, test, integration)

  • Application overview (The application's home page and elevator pitch)

  • Application user guide (desktop, server, browser extension)

  • Bug reporting template

  • Communication guidelines (how to reach maintainers, what channels are monitored, when to raise an issue, etc.)

  • Conceptual overview (what do you need to know about the ecosystem to make sense of this documentation?)

  • Contributors' guide (the different ways you can contribute to this project, and how to start contributing.)

  • Getting started guide (quickstart "hello world" - short, explicit instructions to show simplest use)

  • Glossary / Term Definition / Acronym List

  • Governance documentation (how to participate in a project, separate from contributing)

  • How-to (how to action a specific goal or action. See https://schema.org/HowTo )

  • Installation instructions (library)

  • Issue template

  • Pull request template

  • README

  • Release note

  • Style guide (for code)

  • Style guide (for documentation)

  • Tutorial (project-length instructions on how to learn a concept related to a typical tasks)

Clone this wiki locally