Difference between revisions of "Documentation/Dashboard/CMS Evaluation"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Tools to Evaluate)
(Requirements)
Line 13: Line 13:
 
==Requirements==
 
==Requirements==
  
Enter requirements that a content management framework should meet. Think
+
Enter requirements that a content management framework should meet. Think problem, not solution.
problem, not solution.
+
  
{|border=1 style="border-collapse:collapse;" cellpadding=3 width=100%
+
{|class="prettytaqble sortable"
 
|-style="background-color:#AACCFF"
 
|-style="background-color:#AACCFF"
!Requirement !!Priority !!Notes
+
!Requirement !!Description !!Priority !!Notes
 
|-
 
|-
|'''Usability:''' easy of use and unambiguousness for end users
+
|Usability
 +
|Easy of use and unambiguousness for end users
 
* search confined to one language (eventually with optional search in several different languages)
 
* search confined to one language (eventually with optional search in several different languages)
 
* clearcut content (e.g. "user help & program documentation"), not intermingled with project related stuff (like in the services-wiki)
 
* clearcut content (e.g. "user help & program documentation"), not intermingled with project related stuff (like in the services-wiki)
|Highest ;-)
+
|High
 
|if the intended target audience for the tool is the end user (if not, cancel this req!)
 
|if the intended target audience for the tool is the end user (if not, cancel this req!)
 
|-
 
|-
|'''Easy translation process:''' with one mouseclick to template for translation <br />The translation is reached by a flag-language-changer.
+
|Easy translation process
|Very high
+
|with one mouseclick to template for translation <br />The translation is reached by a flag-language-changer.
 +
|High
 
|
 
|
 
|-
 
|-
|'''Different documentation formats:''' Different mimetypes are allowed to up- and download.<br />ODF-Files and PDF-Files are displayed inside the framework without converting.
+
|Different documentation formats
|Very high ;-)
+
|Different mimetypes are allowed to up- and download.<br />ODF-Files and PDF-Files are displayed inside the framework without converting.
 +
|High
 
|See and read online, what you could get :-)
 
|See and read online, what you could get :-)
 
|-
 
|-
|'''Workflow management:''' Different areas of documentation types: from lower proof of quality to high proof (with workflow).<br />Management of rights for every object inside the framework (directory, file etc.)
+
|Workflow management
|Very high ;-)
+
|Different areas of documentation types: from lower proof of quality to high proof (with workflow).<br />Management of rights for every object inside the framework (directory, file etc.)
 +
|High
 
|Like in OOoAuthors we also need documentation with high quality ;-)
 
|Like in OOoAuthors we also need documentation with high quality ;-)
 
|-
 
|-
|'''Not finished documents unpublished:''' Documentation, which are in work and not finished could hold status private.
+
|Draft Documentation
 +
|Documentation, which are in work and not finished could hold status private.
 
|high
 
|high
 
|Work could be saved on the server (also it is not fished and ready for publishing)
 
|Work could be saved on the server (also it is not fished and ready for publishing)
 
|-
 
|-
|'''Dynamic navigation bar:''' A dynamic and quick to use navigation bar to navigate in the structure. Easy change to another language (with language changer / flag)
+
|Dynamic navigation bar
 +
|A dynamic and quick to use navigation bar to navigate in the structure. Easy change to another language (with language changer / flag)
 
|high
 
|high
 
|
 
|
 
|-
 
|-
|'''Different skins /views for anonymous visitors and contributors:''' An anonymous visitor needs only displayed content. A contributor needs a framework with tools (for editing etc.)
+
|Different skins /views for anonymous visitors and contributors
 +
|An anonymous visitor needs only displayed content. A contributor needs a framework with tools (for editing etc.)
 
|high
 
|high
 
|
 
|
 
|-
 
|-
|'''Modularity:''' Being able to aggregate content modules in different documentation types
+
|Modularity
 +
|Being able to aggregate content modules in different documentation types
 
|high
 
|high
 
|
 
|
 
|-
 
|-
|'''Automatic output to PDF/ODF:''' for post-processing, for example hardcopy publishing, bundling
+
|Automatic output to PDF/ODF
 +
|for post-processing, for example hardcopy publishing, bundling
 
|medium
 
|medium
 
|
 
|
 
|-
 
|-
|'''API for automated content processing:''' for implementing bot-based changes, accessing content from outside and feed them into other (publication) processes
+
|API for automated content processing
 +
|for implementing bot-based changes, accessing content from outside and feed them into other (publication) processes
 
|medium
 
|medium
 
|
 
|
 
|-
 
|-
|'''Extensible:''' for being able to extend the framework with additional functionality (for example, thru plugin technology)
+
|Extensible
 +
|for being able to extend the framework with additional functionality (for example, thru plugin technology)
 
|medium
 
|medium
 
|
 
|
 
|-
 
|-
|'''Controlled access:''' Making sure that access rights can be controlled. Users must agree to Terms of Use and sign Contributor Agreement.
+
|Controlled access
 +
|Making sure that access rights can be controlled. Users must agree to Terms of Use and sign Contributor Agreement.
 
|high
 
|high
 
|
 
|

Revision as of 10:41, 14 March 2008

Template:Documentation/Banner


This page is intended to collect and discuss requirements, processes, and tools to implement a content management framework that allows maintenance of multilingual documentation. The goal is to find a way to intelligently create, update, localize, and publish documentation in multiple languages. We are in agreement, that the current Mediawiki-based solution, while having unbeatably low barrier to contribution, lacks basic content management functions required to maintain documentation in multiple languages, and publish documentation that went through review and quality assurance cycles.

Requirements

Enter requirements that a content management framework should meet. Think problem, not solution.

Requirement Description Priority Notes
Usability Easy of use and unambiguousness for end users
  • search confined to one language (eventually with optional search in several different languages)
  • clearcut content (e.g. "user help & program documentation"), not intermingled with project related stuff (like in the services-wiki)
High if the intended target audience for the tool is the end user (if not, cancel this req!)
Easy translation process with one mouseclick to template for translation
The translation is reached by a flag-language-changer.
High
Different documentation formats Different mimetypes are allowed to up- and download.
ODF-Files and PDF-Files are displayed inside the framework without converting.
High See and read online, what you could get :-)
Workflow management Different areas of documentation types: from lower proof of quality to high proof (with workflow).
Management of rights for every object inside the framework (directory, file etc.)
High Like in OOoAuthors we also need documentation with high quality ;-)
Draft Documentation Documentation, which are in work and not finished could hold status private. high Work could be saved on the server (also it is not fished and ready for publishing)
Dynamic navigation bar A dynamic and quick to use navigation bar to navigate in the structure. Easy change to another language (with language changer / flag) high
Different skins /views for anonymous visitors and contributors An anonymous visitor needs only displayed content. A contributor needs a framework with tools (for editing etc.) high
Modularity Being able to aggregate content modules in different documentation types high
Automatic output to PDF/ODF for post-processing, for example hardcopy publishing, bundling medium
API for automated content processing for implementing bot-based changes, accessing content from outside and feed them into other (publication) processes medium
Extensible for being able to extend the framework with additional functionality (for example, thru plugin technology) medium
Controlled access Making sure that access rights can be controlled. Users must agree to Terms of Use and sign Contributor Agreement. high

Tools to Evaluate

See also the Wikipedia list of CMSs

Tool Description/URL Pros Cons
Plone CMS built on top of Zope, e.g. http://www.oooauthors.org, http://www.plone.org
  • very low entry threshold
  • dynamic navigation
  • tools for editing like wordprocessor
  • multilingual support right out of the box
  • external editor posible
  • many extensions (products) available
  • ODF files support (also preview inside the cms)
Mediawiki with Extensions
  • supposed lowest entry threshold
  • best suited for setting up a "quick and dirty pilot environment" (e.g. for trying out workflows)
  • very large estension base
  • existing implementation
  • not well suited to implement specific behavior (e.g. automatized workflows)
Drupal Very popular CMS
  • Rich in multilingual and translation support
  • Very widely used, so familiar to users
Alfresco Alfresco is the Open Source Alternative for Enterprise Content Management (ECM), providing Document Management, Collaboration, Records Management, Knowledge Management, Web Content Management and Imaging.
  • sophisticated, enterprise-level CMS
  • ODF integration
Learning curve?
Personal tools