Documentation Task-Supporting System

A Documentation Task-Supporting System is a computing system that can help to solve a documentation task (through documentation creation, documentation management, and documentation delivery).

• AKA: Documentation Platform, Documentation Software, Documentation Management System, Documentation Tool.
• Context:
  • It can typically create Documentation Content through documentation authoring interfaces.
  • It can typically organize Documentation Structure using documentation taxonomy.
  • It can typically manage Documentation Version Control via documentation revision tracking.
  • It can typically generate Documentation Output in documentation formats.
  • It can typically enforce Documentation Standards through documentation templates.
  • ...
  • It can often support Documentation Collaboration via documentation workflows.
  • It can often enable Documentation Search through documentation indexing mechanisms.
  • It can often provide Documentation Analytics for documentation usage tracking.
  • It can often implement Documentation Automation using documentation generation rules.
  • ...
  • It can range from being a Simple Documentation System to being a Complex Documentation System, depending on its documentation capability level.
  • It can range from being a Manual Documentation System to being an Automated Documentation System, depending on its documentation automation degree.
  • ...
  • It can integrate with Source Code Repositorys for documentation synchronization.
  • It can connect to Content Management Systems for documentation publication.
  • It can interface with Translation Management Systems for documentation localization.
  • It can communicate with Build Automation Systems for documentation continuous integration.
  • It can synchronize with Issue Tracking Systems for documentation maintenance.
  • ...
• Examples:
  • Technical Documentation Systems, such as:
    • API Documentation Systems, such as:
      • Swagger Documentation System for API documentation specification.
      • Postman Documentation System for API documentation testing.
    • Code Documentation Systems, such as:
      • Doxygen for source code documentation extraction.
      • Javadoc for Java documentation generation.
  • Knowledge Management Documentation Systems, such as:
    • Wiki-Based Documentation Systems, such as:
      • MediaWiki for collaborative documentation creation.
      • Confluence for enterprise documentation management.
    • Help Systems, such as:
      • Zendesk Guide for customer documentation portal.
      • MadCap Flare for help documentation authoring.
  • Enterprise Documentation Systems, such as:
    • Component Content Management Systems, such as:
      • Adobe FrameMaker for structured documentation authoring.
      • Oxygen XML Editor for DITA documentation creation.
    • Documentation Portals, such as:
      • ReadMe for developer documentation hosting.
      • GitBook for version-controlled documentation.
  • Specialized Documentation Systems, such as:
    • Medical Documentation Systems, such as:
      • Epic Documentation System for clinical documentation.
      • Cerner Documentation Platform for healthcare documentation.
    • Legal Documentation Systems, such as:
      • iManage for legal document management.
      • NetDocuments for law firm documentation.
  • ...
• Counter-Examples:
  • Text Editors, which create text files but lack documentation management capability.
  • File Storage Systems, which store documents but lack documentation workflow features.
  • General Content Management Systems, which manage web content but lack documentation-specific functionality.
• See: Annotation System, LODE Service, Curation System, Documentation Task, Knowledge Management System, Content Management System, Technical Writing Tool.

---

---