Content Reports (Curation)

    Introduction

    Managing a growing corpus of content can be an overwhelming task for understaffed curators. Content reports are the first tool to allow curators to discover content which need attention. In essence, these reports provide content-specific analytics that direct editing activity to areas of need - refreshing with relevancy for the consumers of that content.

    Intended Audience

    These reports are to be utilized by content curators to discover areas of attention - whether it's hot activity or stale sections of content.

    Status

    Initial scoping by RoyK; to be a part of the Olympic release.

    Functional Specification

    Use Cases

    Curator discovers areas of user-reported poor quality content (quality report)

    The goal of this report is to improve content accuracy by providing reports which allow curators to identify areas of documentation which need to be made more relevant to the end-users (as reported by them).

    Using content rating scoring, the curator can see a visual representation of the distribution of pages with content rating scoring. High-level metrics will show the average rating of a page within MindTouch as well as the percentage of rated pages and the total pages within the system (the last two data points are to give context of the sample size).

    The curator can also break down the reporting to small subsets by using search queries - in this case, the metrics and the distribution reflect the data within that searched subset (a common example will be to limit the content quality to a specific path). When searching, the metrics will also update to reflect the values comparatively to the rest of the site.

    Below the graph and the metrics is a sorted report which shows the pages with thw lowest quality score to allow curators the ability to focus their attention on areas of poorly rated content.

    View for non-search mode

    dashboard_rating_no-search.png

    View for searched mode (note the updated metrics)

    dashboard_rating_search.png

    Curator discovers stale content (aging report)

    This report helps answer the question: "How fresh is the content on my site?". From this view, curators will be able to discover the oldest content that hasn't been touched (and thus prune "outdated" content).

    The chart in this report will show a distribution of pages since the last edit date: 0-3 months, 4-6 months, 7-12 months, 12-23 months, and 24 months+.

    The metrics shown: total pages & last average edited date (or last edited age).

    dashboard_aging-no-search.png

    dashboard_aging-search.png

    Curator discovers areas of attention - hotspots (activity report)

    The purpose of this report is to highlight areas of high interest (based on activity) to the users.

    Curator wants to understand the maturity of content (staging report)

    The purpose of this report is to help curators understand the maturity of their content by visualizing the content state (as defined by a stage; for example - "needs review" or "to be edited").

    Curator wants to find requested content (search report)

    The purpose of this report is to shed insight into what people are searching for, and what pages they are finding when searching for concepts.

    dashboard_search.png

    Non-goals

    Technical Specification

    Hierarchy: (Olympic work items)

    • Content Reports
      • Stage Report 
      • Hotspots Report
      • Quality Report
        • Rating Report
        • Requested Pages Report
      • Aging Report
        • Last active report
        • Number of links per page (v2)
      • Participation (v2)
      • Reponsiveness (v2)
      • Search
        • Searched terms report
      • Read wear report (v2)
      • Popularity report (v2)

    UI requirements

    These reports will be built with DekiScript (and utilize DekiScript special pages). Any charting components will rely on the MindTouch Charting commercial add-on.

    Common UI Requirements

    Many of the dashboard views will maintain UI consistency. Here are the elements to most reports:

    report_overview.png
    1. Tabbed interface that show all reports
    2. Search component which will repopulate the reports based on the Lucene query
    3. Visual representation of some data points, relevant to the particular report
    4. Pre-defined metrics about a given report. In the case of an unfiltered report (viewing all pages), a link is provided by each metric to a historic view of that information. When filtered, will provide a reference point against the site's value.
    5. Table view of pages relevant to this particular report; pagination/sorting controls are available. The table view for all reports is the same and contains the following columns: (* indicate sortable values)
      • Rating (score* and count)
      • Page (title*, path, tags)
      • Last edited date*
      • View count*
      • Edit count*
      • Comment count*

    Reporting Service

    Queries a MindTouch instance and extracts data in a format suitable for charting.

    SID: sid://mindtouch.com/ent/2010/05/reporting

    Functions

    The following DekiScript functions are exposed by the service

    Report
    report(name : str?, query : str?) : xml
    Parameters
    Name Type Description
    name str? (optional. default: all reports) name of the report to run
    query str? (optional, default: all pages) a Lucene query that filters the scope of the report
    Result

    For each report series data suitable for charting and metadata about the series is exposed.

    Sample Output

     

    { 
        "meta": { 
            "aging": { 
                "average": 0, 
                "count": 19, 
                "max": 0, 
                "min": 0
            }, 
            "rating": { 
                "average": 100, 
                "count": 1, 
                "max": 100, 
                "min": 100
            }
        }, 
        "series": { 
            "aging": [ 
                { 
                    "0-3": 19
                }, 
                { 
                    "4-6": 0
                }, 
                { 
                    "7-12": 0
                }, 
                { 
                    "13-24": 0
                }, 
                { 
                    "25+": 0
                }
            ], 
            "rating": [ 
                { 
                    "0-19": 0
                }, 
                { 
                    "20-39": 0
                }, 
                { 
                    "40-59": 0
                }, 
                { 
                    "60-79": 0
                }, 
                { 
                    "80-100": 1
                }
            ]
        }
    }
    Tag page

    Files 12

    FileVersionSizeModified 
    Viewing 1 of 1 comments: view all
    This looks fabulous, am looking forward to using it. thanks.
    Posted 00:44, 24 Mar 2010
    Viewing 1 of 1 comments: view all
    You must login to post a comment.

    Copyright © 2011 MindTouch, Inc. Powered by