Version Controlled Documentation

Model Version Controlled Documentation helps to create and manage documentation of products that are issued in versions and after adapting also any other type of documentation. This ObjectGears application is interesting also from the licensing point of view since we can typically manage it with a low number of users that have to be authenticated, Version Controlled Documention is intended for sharing with external (unauthenticated) users both from the organization or from internet. Therefore, such a solution can be operated in the ObjectGears free version.

create and manage documentation of products that are issued in versions

effective and efficient system that will help you define to which versions newly created article relateImagine that you are developing an application that is used by your customers. At the moment you have versions 1.0, 1.1 and 1.2 at your customers. In order all the customers could use your application in a fully-fledged way, they have to have documentation available for the version that they use. So it is not enough to maintain documentation just for the last version but also for all the previous versions. Since you are permanently extending documentation with new articles relating also to the previous versions you need an effective and efficient system that will help you define to which versions newly created article relate. This is the purpose of of the Version Controlled Documentation module. You can see its real-life use on web https://doc.objectgears.cz/vcd?lang=en-US, where it is used for documentation of the ObjectGears system.

Documentation supports:

  • article creation by means of HTML editort
  • article hierarchy (child and parent articles)
  • content in form of texts, tables, pictures, attached files, videos, links to other articles
  • search of articles by readers
  • evaluation of articles by readers
  • article version management and language variants (article is displaying its content according to the selected version and user language preference)
  • article tags
  • search results sorted according to the relevance
  • an effective support for article authors (overviews of articles that need attention, various possibilities for linking articles by references...)
  • wide possibilities of configuration and customization according to customer needs (including look and feel)
  • article statistics

Watch a short introduction of this solution.

You can find more information in an article about Version Controlled documentation in  Verzované dokumentaci.