The Software Engineering
latest
  • SSH
  • Agile Software Engineering
  • Linux and Shell Programming
  • Atlassian Jira
  • Git
  • Docker
  • Jenkins
  • Software Architecture, Cloud, Microservices
  • Puppet
  • Ansible
  • SonarQube
  • Vagrant
  • Code Review
  • Summary
    • 1. Agility
    • 2. Binary Repository
    • 3. Continuous Integration
    • 4. Database
    • 5. Documentation
      • 5.1. Language
      • 5.2. Api Documentation
      • 5.3. Documentation
      • 5.4. Knowledge Base
      • 5.5. Instant Messaging
      • 5.6. Issue Tracker
    • 6. Provisioning
    • 7. Quality Control
    • 8. System Administration
    • 9. Version Control System
    • 10. Virtualization
    • 11. Recap
  • Further Reading
The Software Engineering
  • »
  • Summary »
  • 5. Documentation
  • Edit on GitHub

5. Documentation

Contents

  • Documentation

    • Language

    • Api Documentation

    • Documentation

    • Knowledge Base

    • Instant Messaging

    • Issue Tracker

5.1. Language

  • .md - Markdown

  • .rst - Restructured Text

5.2. Api Documentation

  • Swagger https://petstore3.swagger.io

  • reDoc https://github.com/Redocly/redoc

5.3. Documentation

  • Sphinx Doc https://www.sphinx-doc.org/

  • Docuzaurus https://docusaurus.io

  • Jekyll https://jekyllrb.com

  • Github pages

  • Executable Book Project https://executablebooks.org/

  • Gatsby https://www.gatsbyjs.com/docs/

  • VuePress https://vuepress.vuejs.org

5.4. Knowledge Base

Server:

  • Confluence

  • Wiki

  • GitLab

Cloud:

  • Confluence Cloud

  • Media Wiki

  • GitLab

  • Github

5.5. Instant Messaging

Server:

  • Rocket Chat https://rocket.chat

  • Microsoft Teams https://www.microsoft.com/en-us/microsoft-teams/group-chat-software

Cloud:

  • Slack https://slack.com/

  • Microsoft Teams https://www.microsoft.com/en-us/microsoft-teams/group-chat-software

  • Zoom https://zoom.us

  • Google Meet https://meet.google.com

  • Cisco Webex https://www.webex.com

5.6. Issue Tracker

Server:

  • Jira

  • Redmine

  • Kunagi

  • Git Lab

Cloud:

  • Jira Cloud

  • Trello

  • Asana

  • Git Lab

  • Github

Previous Next

© Copyright 2022, CC-BY-SA-4.0, Matt Harasymczuk <matt@astrotech.io>, last update: 2022-05-18. Revision 49ffcc8c.

Read the Docs v: latest
Versions
latest
Downloads
On Read the Docs
Project Home
Builds