The most overlooked part in software development - writing project documentation

1

Confluence

You are probably already writing your project documentation: writing comments in code, writing project-specific stuff in Google Docs, describing project integrations in Confluence, discussing implementations through communication channels like Slack or Skype. Everything that relates to your project is project documentation and it will be relevant at some point in time, especially after the project moves to support mode.

#Content Collaboration #WiKi #Task Management

2

Sphinx Search

# Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)import sys, os import sphinx_rtd_theme

#Search Engine #Custom Search Engine #Full-text Search 10 social mentions

3

MkDocs

MkDocs calls itself a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. It is Python-based. Documentation source files are written in Markdown and configured with a single YAML configuration file. On its Wiki page it provides a long list of themes, recipes and plugins making it a very attractive system for writing documentation. YAML configuration and Markdown syntax make this system very easy to use and customize. You can check the eZ Platform documentation, which is written with the help of MkDocs.

#Documentation #Documentation As A Service & Tools #Knowledge Base 2 social mentions

4

Docusaurus

It markets itself as an easy-to-maintain open source documentation website. It is Markdown-powered, built using React, supports translations, document versioning and document search with the help of Algolia. It is built on Node and was developed by Facebook. The whole range of Facebook’s open-source projects build their documentation with Docusaurus. An example project that is non-Facebook and uses Docusaurus is Babel. It is a well-documented and beautiful documentation system that is worth checking.

#Documentation #Documentation As A Service & Tools #Static Site Generators 192 social mentions

5

GitBook

GitBook is a paid documentation system that is hosted in cloud. Compared to previous systems, GitBook requires almost no time to set up. After the registration it becomes available instantly, providing free collaboration for two users with one private and one public space. GitBook supports Markdown syntax, rich embeds and rich content, and plethora of integrations with third-party services like Slack, Google Analytics and Github, making it the most advanced all-round documentation system of them all. As a point of reference you can check its documentation.

#Documentation #Documentation As A Service & Tools #Knowledge Management 2 social mentions