1. Case study: Version Controlled Documentation - Requirements

    Article: AN0002333Updated: 05.11.2018

    In this chapter we will describe requirements on the Version Controlled Documentation, i.e. application that we want to create in ObjectGears.

    There should be three types of users that should work with the Version Controlled Documentation:

    1. Reader (unauthenticated user) - searches for articles, displays them and evaluates.
    2. Editor - writes articles of the documentation and updates them.
    3. Administrator - maintains master data like list of versions or languages and performs mass updates if necessary.

    Article reader will be able to:

    1. search articles
      1. by texts that they should contain
      2. by keywords (tags)
      3. by going through structure of articles (tree of parent and child articles)
      4. by article identifier
    2. navigate between articles by means of links by which they are linked
    3. evaluate articles

    Article editor will be able to:

    1. Create new articles.
    2. Edit current articles.
    3. Create new keywords (tag).
    4. Step by step prepare a new version of the text, while current version of the text is displayed.
    5. Indicate that the article should be translated or checked from the perspective of content or grammar.
    6. Display overview of all the articles the require his attention.

    Administrator will be able to:

    1. Administer master data (languages, versions, topics),
    2. Perform mass updates with data.

    It will be possible to:

    1. Define various text versions for each article for various product versions and various languages.
    2. Define for each article text version, for which product version and which language it should be dislayed.
    3. Display formatted text, tables, links to other articles or to content outside of the Version Controlled Documentation, files, videos, related articles, tags.
    4. Since each article will be displayed on web, it will be possible to define html tags and url in each text.
    5. Each article will have its unique code, by means of which it can be looked up.