Difference between revisions of "Documentation/Dashboard/Competitive Documentation Analysis"
(→Recommendations for OpenOffice) |
(→Recommendations for OpenOffice) |
||
Line 265: | Line 265: | ||
|| | || | ||
* Use more indices in printed material. | * Use more indices in printed material. | ||
− | * In help create an application specific contents tab. (Now, the left side of the help window has always the same folders listed. | + | * Apply the index terms that users use. |
− | * In help allow search for similar words (fuzzy search) so that spelling mistakes and languages cases would have no influence on search results. | + | * In help create an application specific contents tab. (Now, the left side of the help window has always the same folders listed.) Or, at least, bring the main chapters of the contents tab in a reasonable order. |
+ | * In help allow search for similar words (fuzzy search) so that spelling mistakes and languages cases would have no influence on search results. (see WordPerfect Office) | ||
* In help repair the full text search (see issues 45826, 38553 and 61820). | * In help repair the full text search (see issues 45826, 38553 and 61820). | ||
− | * In help combine index and full text search into one search box. | + | * In help combine index and full text search into one search box. (see Microsoft Office) |
|| for | || for | ||
|- bgcolor="#FFF" valign="top" | |- bgcolor="#FFF" valign="top" | ||
|'''Information types''' | |'''Information types''' | ||
|| | || | ||
− | * In help separate help topics in mere conceptual and mere instructional content. | + | * In help separate help topics in mere conceptual and mere instructional content. (see WordPerfect Office) |
* Remove conceptual content from the help and collect it in a printable document or the wiki where the user can look it up when needed. | * Remove conceptual content from the help and collect it in a printable document or the wiki where the user can look it up when needed. | ||
* From instructional topics link to conceptual topics. | * From instructional topics link to conceptual topics. | ||
− | * Formulate topic titles in such a way that the user recognizes whether it contains more instructional or more conceptual content. | + | * Formulate topic titles in such a way that the user recognizes whether it contains more instructional or more conceptual content. (see WordPerfect Office) |
* Use more examples, particularly in documentations for beginners. | * Use more examples, particularly in documentations for beginners. | ||
+ | * Adopt the more user-friendly function reference help from Microsoft Excel: Each function category of our category list should be linked to a list of the corresponding functions with short descriptions. Based on the descriptions the user can then select the appropriate function. | ||
|| for | || for | ||
|- bgcolor="#FFF" valign="top" | |- bgcolor="#FFF" valign="top" | ||
Line 286: | Line 288: | ||
* In the table of contents of the OpenOffice User Guide highlight chapter titles, do not provide more than three chapter levels and create chapter groups. | * In the table of contents of the OpenOffice User Guide highlight chapter titles, do not provide more than three chapter levels and create chapter groups. | ||
* Do not indent bullets and numbers in lists. | * Do not indent bullets and numbers in lists. | ||
− | * In online help use tables also for action alternatives. If we use normal text for menu selections, we could use tables for action alternatives (for example, context menus and icons). | + | * In online help use tables also for action alternatives. If we use normal text for menu selections, we could use tables for action alternatives (for example, context menus and icons). (see WordPerfect Office) |
+ | * Use more visual stimulants (for example colors, graphics to illustrate concepts) (see Microsoft Office) | ||
|| for | || for | ||
|- bgcolor="#FFF" valign="top" | |- bgcolor="#FFF" valign="top" | ||
|'''Navigation''' | |'''Navigation''' | ||
− | || | + | || |
+ | * In the OpenOffice User guide use more links and cross-references. | ||
|| for | || for | ||
|- bgcolor="#FFF" valign="top" | |- bgcolor="#FFF" valign="top" |
Revision as of 10:19, 9 July 2007
Competitive Documentation Analysis
<Abstract>
Contents
Project Owner
Competitor Products
OpenOffice.org/StarOffice | Microsoft Office | WordPerfect Office | SoftMaker Office | GNOME Office | KOffice |
---|---|---|---|---|---|
Writer | Word | WordPerfect | TextMaker | AbiWord | KWord |
Calc | Excel | QuattroPro | PlanMaker | Gnumeric | KSpread/KChart |
Impress | PowerPoint | Presentations | Presentations | - | KPresenter |
Draw | - | - | (vector drawing integrated in TextMaker) | (GIMP/Inkscape) | Karbon14/Krita |
Base | (Access) | (Paradox) | DataMaker | Gnome-DB | Kexi |
Math | - | - | Editor for math. formulas | - | Kformula |
Windows, Unix, Linux, (OS X) | Windows, OS X | Windows | Windows, Linux | Windows, Unix, (OS X) | Unix, Linux |
Other competitor products that were not analyzed are:
- iWork and Apple Works from Apple
- Ability Office from Ability Software
- Applixware from Vista Source
- ONE from e-press
- Lotus SmartSuite from IBM (Lotus)
- Papyrus from R.O.M. Logicware
- ThinkFree Office from ThinkFree Office
- Mariner Pak from Mariner Software
For further information look at Comparison of office suites in Wikipedia
Competitive Analysis
- Documentation types:
to get an overview of how much documentation is designed for being printed and how much documentation is designed for online use, and to see what different types of documentation are existing (help, manuals, tutorials, training courses, videos, tips and tricks ...)
OpenOffice.org/StarOffice | Microsoft Office | WordPerfect Office | SoftMaker Office | GNOME Office | KOffice |
---|---|---|---|---|---|
|
|
|
|
|
"* PerfectExpert is a tool for beginners, a totally conceptual help with templates and tutorials that provide advice and guidance specific to the task"
- Search functions
to have a closer look at the different search functionalities in Application Help and printed documentation (search boxes, index, glossary, chapter headings ...)
OpenOffice.org/StarOffice | Microsoft Office | WordPerfect Office | SoftMaker Office | GNOME Office | KOffice |
---|---|---|---|---|---|
|
|
|
|
|
|
- Information types
to rate the distribution of the four information types:
- instructional information: detailed stepwise instructions
- conceptual information: explanation of specific office terms, particularly important for beginners
- referential information: functional descriptions (of dialog items or spreadsheet functions for example)
- examplary information: examples that help to understand actions and concepts.
OpenOffice.org/StarOffice | Microsoft Office | WordPerfect Office | SoftMaker Office | GNOME Office | KOffice |
---|---|---|---|---|---|
|
|
|
|
|
|
- Visualization
to examine the visual elements that help understanding text (graphics, icons, tables, screenshots, colors, layout)
OpenOffice.org/StarOffice | Microsoft Office | WordPerfect Office | SoftMaker Office | GNOME Office | KOffice | |
---|---|---|---|---|---|---|
Graphics | none | to explain concepts (for ex. footers) | to explain concepts, with captions | none | none | to explain concepts, barely used |
Icons | for buttons, notes, tips | for tips, notes | for buttons, tips, notes | for buttons | for buttons, tips, notes (badly integrated in text) | for buttons (badly integrated in text) |
Tables | for shortcut lists and some other stuff | for shortcut lists and Excel functions | for shortcuts lists, QuattroPro functions and instructional text ("You can also...", "To ... do the following") | simple but clear, for shortcut lists, commands, icon explanations | barely used and in a mess | barely used |
Screenshots | in spreadsheet examples and to explain the workspace | to explain screen elements | in spreadsheet examples and to explain the workspace | to explain the workspce and particular screen elements, frequent in instructional information | no consistent use | frequent in instructional information |
Colors | none | for headings and definitions | none | for notes and tips background, bullets and numbers and marks in screenshots | for marks in screenahots | for marks in pictures and terminal commands |
- Navigation
to see how links and cross-references are used
OpenOffice.org/StarOffice | Microsoft Office | WordPerfect Office | SoftMaker Office | GNOME Office | KOffice |
---|---|---|---|---|---|
|
|
|
|
|
|
- Contents organization
to answer the questions "Where are the contents?" and "Are the contents easy to find?"
OpenOffice.org/StarOffice | Microsoft Office | WordPerfect Office | SoftMaker Office | GNOME Office | KOffice |
---|---|---|---|---|---|
|
|
|
|
|
|
Recommendations for OpenOffice
Recommendations | Reason | |
---|---|---|
Documentation types |
|
to |
Search functions |
|
for |
Information types |
|
for |
Visualization |
|
for |
Navigation |
|
for |
Contents organization |
|
for |
Content on this page is licensed under the Public Documentation License (PDL). |