You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by "Fabian Christ (Resolved) (JIRA)" <ji...@apache.org> on 2012/03/15 14:29:38 UTC

[jira] [Resolved] (STANBOL-448) Add high level descriptions to each Stanbol component

     [ https://issues.apache.org/jira/browse/STANBOL-448?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Fabian Christ resolved STANBOL-448.
-----------------------------------

    Resolution: Fixed

Documentation was improved. For new improvements we should create new specific issues.
                
> Add high level descriptions to each Stanbol component
> -----------------------------------------------------
>
>                 Key: STANBOL-448
>                 URL: https://issues.apache.org/jira/browse/STANBOL-448
>             Project: Stanbol
>          Issue Type: Improvement
>          Components: website
>            Reporter: Fabian Christ
>              Labels: documentation
>
> 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.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira