Stanbol
  1. Stanbol
  2. STANBOL-448

Add high level descriptions to each Stanbol component

    Details

      Description

      For a newbie user it is difficult to understand what the different Stanbol components are about. We have to care about the people with little or no knowledge about semantic technologies. There is no good overview description for newbies and figures are missing.

      Add high level descriptions to each component on the web site that follows this simple structure:

      1. paragraph: Describe the component's rationale for newbies. What it is used for?
      2. paragraph: Describe classical usage scenarios, anecdotes, use cases. Conceptual figures might help here.
      3. paragraph: Describe the main features on a more concrete level. Perhaps say something about the architecture and design decisions.
      4. paragraph: Give a summary and point to further readings, API docs, source code, etc.

        Issue Links

          Activity

          Hide
          Fabian Christ added a comment -

          The high level overview should link to the components.

          Show
          Fabian Christ added a comment - The high level overview should link to the components.
          Hide
          Olivier Grisel added a comment -

          It seems that there is already a fair amount of high level descriptions here:

          https://incubator.apache.org/stanbol/docs/trunk/components.html

          We should not re-start from scratch but rather improve upon the existing doc.

          Show
          Olivier Grisel added a comment - It seems that there is already a fair amount of high level descriptions here: https://incubator.apache.org/stanbol/docs/trunk/components.html We should not re-start from scratch but rather improve upon the existing doc.
          Hide
          Fabian Christ added a comment -

          Sure there are some descriptions. But if you read those pages from the perspective of a newbie you see a lot of terms that are not explained.

          Anyway: I agree that we should not re-start. The idea was to improve what we have.

          Show
          Fabian Christ added a comment - Sure there are some descriptions. But if you read those pages from the perspective of a newbie you see a lot of terms that are not explained. Anyway: I agree that we should not re-start. The idea was to improve what we have.
          Hide
          Fabian Christ added a comment -

          Documentation was improved. For new improvements we should create new specific issues.

          Show
          Fabian Christ added a comment - Documentation was improved. For new improvements we should create new specific issues.

            People

            • Assignee:
              Unassigned
              Reporter:
              Fabian Christ
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development