header icons

Documentation Metrics


All metrics used in the maturity assessment process are described thereafter, with useful information and references. They are classified according to their source.



  • ITS authors ( ITS_AUTH_3M )

    Provided by: polarsys_grimoire

    Used by: ITS_USAGE

    Scale: 1 < 2 ≤ 2 < 4 ≤ 3 < 9.75 ≤ 4 < 80 ≤ 5

    Number of distinct identities updating tickets during the last three months, in the issue tracking system.

    The subset of tickets considered from the issue tracking system are those specified in the project documentation, for example by specifying a tracker or a project name appearing in ticket data. Update means an operation on a ticket changing its state, or adding information. Opening and closing a ticket are considered as updates. Identities of updaters are the character strings found in the corresponding field in the ticket information. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

  • Defect density ( ITS_BUGS_DENSITY )

    Provided by: polarsys_grimoire

    Used by: ITS_REL

    Scale: 1 < 3.36826347305 ≤ 2 < 0.0755602867593 ≤ 3 < 0.0335380213652 ≤ 4 < 0.009367219332 ≤ 5

    Ratio of the total number of tickets in the issue tracking system to the size of the source code in KLOC, at the time of the data retrieval.

    The subset of tickets considered from the issue tracking system are those specified in the project documentation, for example by specifying a tracker or a project name appearing in ticket data. Source code is all source code found in the source code management repository.

  • Number of open bugs ( ITS_BUGS_OPEN )

    Provided by: polarsys_grimoire

    Used by: ITS_REL

    Scale: 1 < 500 ≤ 2 < 200 ≤ 3 < 100 ≤ 4 < 50 ≤ 5

    Number of tickets marked as still open at the time of the data retrieval, in the issue tracking system.

    The subset of tickets considered from the issue tracking system are those specified in the project documentation, for example by specifying a tracker or a project name appearing in ticket data. Open means the state in which further actions are usually expected until the ticket is closed.

  • Median time to fix bug ( ITS_FIX_MED_3M )

    Provided by: polarsys_grimoire

    Used by: ITS_REL

    Scale: 1 < 1001.13 ≤ 2 < 40.2625 ≤ 3 < 11.62 ≤ 4 < 3.82 ≤ 5

    Median period from when a ticket is open to when a ticket is closed, for all tickets closed during the last three months, in the issue tracking system.

    The subset of tickets considered from the issue tracking system are those specified in the project documentation, for example by specifying a tracker or a project name appearing in ticket data. Closed means the state in which no further action is usually performed in the ticket. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included). Unit is days.

  • ITS updates ( ITS_UPDATES_3M )

    Provided by: polarsys_grimoire

    Used by: ITS_USAGE

    Scale: 1 < 4 ≤ 2 < 13 ≤ 3 < 37 ≤ 4 < 596 ≤ 5

    Number of updates to tickets during the last three months, in the issue tracking system.

    The subset of tickets considered from the issue tracking system are those specified in the project documentation, for example by specifying a tracker or a project name appearing in ticket data. Update means an operation on a ticket changing its state, or adding information. Opening and closing a ticket are considered as updates. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

  • Developer ML authors ( MLS_DEV_AUTH_3M )

    Provided by: polarsys_grimoire

    Used by: MLS_DEV_DIVERSITY

    Scale: 1 < 1.5 ≤ 2 < 3 ≤ 3 < 7.5 ≤ 4 < 26 ≤ 5

    Number of distinct senders for messages dated during the last three months, in developer mailing list archives.

    Developer mailing list is the list or lists considered as 'for developers' in the project documentation. The date used is the mailing list server date, as stamped in the message. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included). Distinct senders are those with distinct email addresses. Email addresses used are the strings found in 'From:' fields in messages.

    Note that developer communications are measured through the mailing list, and user communications are measured through the forums.

  • Developer ML response ratio ( MLS_DEV_RESP_RATIO_3M )

    Provided by: polarsys_grimoire

    Used by: MLS_DEV_SUPPORT

    Scale: 1 < 0.833333333333 ≤ 2 < 1.24285714286 ≤ 3 < 2.5125 ≤ 4 < 10 ≤ 5

    Average number of messages in thread, minus one, for all threds of messages dated during the last three months, in developer mailing list archives.

    Threads are identified using 'In-Reply-To' message headers. Developer mailing list is the list or lists considered as 'for developers' in the project documentation. The date used is the mailing list server date, as stamped in the message. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

    Note that developer communications are measured through the mailing list, and user communications are measured through the forums.

  • Developer ML response time ( MLS_DEV_RESP_TIME_MED_3M )

    Provided by: polarsys_grimoire

    Used by: MLS_DEV_RESPONSIVENESS

    Scale: 1 < 42.93 ≤ 2 < 0.94 ≤ 3 < 0.26 ≤ 4 < 0.0425 ≤ 5

    Median period from first message in thread to second message in thread, for all threds with at least two messages dated during the last three months, in developer mailing list archives.

    Threads are identified using 'In-Reply-To' message headers. Developer mailing list is the list or lists considered as 'for developers' in the project documentation. The date used is the mailing list server date, as stamped in the message. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included). Unit is days.

    Note that developer communications are measured through the mailing list, and user communications are measured through the forums.

  • Developer ML subjects ( MLS_DEV_SUBJ_3M )

    Provided by: polarsys_grimoire

    Used by: MLS_DEV_SUPPORT

    Scale: 1 < 1 ≤ 2 < 5 ≤ 3 < 15 ≤ 4 < 30 ≤ 5

    Number of threads of messages dated during the last three months, in developer mailing list archives.

    Threads are identified using 'In-Reply-To' message headers. Developer mailing list is the list or lists considered as 'for developers' in the project documentation. The date used is the mailing list server date, as stamped in the message. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

    Note that developer communications are measured through the mailing list, and user communications are measured through the forums.

  • Developer ML posts ( MLS_DEV_VOL_3M )

    Provided by: polarsys_grimoire

    Used by: MLS_DEV_ACTIVITY

    Scale: 1 < 2 ≤ 2 < 6 ≤ 3 < 22 ≤ 4 < 103 ≤ 5

    Number of messages dated during the last three months, in developer mailing list archives.

    Developer mailing list is the list or lists considered as 'for developers' in the project documentation. The date used is the mailing list server date, as stamped in the message. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

    Note that developer communications are measured through the mailing list, and user communications are measured through the forums.

  • User ML authors ( MLS_USR_AUTH_3M )

    Provided by: polarsys_grimoire

    Used by: MLS_USR_DIVERSITY

    Scale: 1 < 1.5 ≤ 2 < 3 ≤ 3 < 7.5 ≤ 4 < 26 ≤ 5

    Number of distinct senders for messages dated during the last three months, in user mailing list archives.

    User mailing list is the list or lists considered as 'for users' in the project documentation. The date used is the mailing list server date, as stamped in the message. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included). Distinct senders are those with distinct email addresses. Email addresses used are the strings found in 'From:' fields in messages.

    Note that developer communications are measured through the mailing list, and user communications are measured through the forums.

  • User ML response ratio ( MLS_USR_RESP_RATIO_3M )

    Provided by: polarsys_grimoire

    Used by: MLS_USR_SUPPORT

    Scale: 1 < 0.833333333333 ≤ 2 < 1.24285714286 ≤ 3 < 2.5125 ≤ 4 < 10 ≤ 5

    Average number of messages in thread, minus one, for all threds of messages dated during the last three months, in user mailing list archives.

    Threads are identified using 'In-Reply-To' message headers. User mailing list is the list or lists considered as 'for users' in the project documentation. The date used is the mailing list server date, as stamped in the message. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

    Note that developer communications are measured through the mailing list, and user communications are measured through the forums.

  • User ML response time ( MLS_USR_RESP_TIME_MED_3M )

    Provided by: polarsys_grimoire

    Used by: MLS_USR_RESPONSIVENESS

    Scale: 1 < 42.93 ≤ 2 < 0.94 ≤ 3 < 0.26 ≤ 4 < 0.0425 ≤ 5

    Median period from first message in thread to second message in thread, for all threds with at least two messages dated during the last three months, in user mailing list archives.

    Threads are identified using 'In-Reply-To' message headers. User mailing list is the list or lists considered as 'for users' in the project documentation. The date used is the mailing list server date, as stamped in the message. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included). Unit is days.

    Note that developer communications are measured through the mailing list, and user communications are measured through the forums.

  • User ML subjects ( MLS_USR_SUBJ_3M )

    Provided by: polarsys_grimoire

    Used by: MLS_USR_SUPPORT

    Scale: 1 < 1 ≤ 2 < 5 ≤ 3 < 15 ≤ 4 < 30 ≤ 5

    Number of threds of messages dated during the last three months, in user mailing list archives.

    Threads are identified using 'In-Reply-To' message headers. User mailing list is the list or lists considered as 'for users' in the project documentation. The date used is the mailing list server date, as stamped in the message. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

    Note that developer communications are measured through the mailing list, and user communications are measured through the forums.

  • User ML posts ( MLS_USR_VOL_3M )

    Provided by: polarsys_grimoire

    Used by: MLS_USR_ACTIVITY

    Scale: 1 < 2 ≤ 2 < 6 ≤ 3 < 22 ≤ 4 < 103 ≤ 5

    Number of messages dated during the last three months, in user mailing list archives.

    User mailing list is the list or lists considered as 'for users' in the project documentation. The date used is the mailing list server date, as stamped in the message. Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

    Note that developer communications are measured through the mailing list, and user communications are measured through the forums.

  • SCM Commits ( SCM_COMMITS_3M )

    Provided by: polarsys_grimoire

    Used by: SCM_ACTIVITY , SCM_USAGE

    Scale: 1 < 2 ≤ 2 < 5 ≤ 3 < 13 ≤ 4 < 121 ≤ 5

    Total number of commits in source code management repositories dated during the last three months.

    Source code management repositories are those considered as such in the project documentation. Commits in all branches are considered. Date used for each commit is 'author date' (when there is a difference between author date and committer date). Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

  • Files committed ( SCM_COMMITTED_FILES_3M )

    Provided by: polarsys_grimoire

    Used by: SCM_ACTIVITY

    Scale: 1 < 3 ≤ 2 < 19 ≤ 3 < 95.75 ≤ 4 < 2189 ≤ 5

    Total number of files touched by commits in source code management repositories dated during the last three months.

    Source code management repositories are those considered as such in the project documentation. Commits in all branches are considered. A file is 'touched' by a commit if its content or its path are modified by the commit. Date used for each commit is 'author date' (when there is a difference between author date and committer date). Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

  • SCM committers ( SCM_COMMITTERS_3M )

    Provided by: polarsys_grimoire

    Used by: SCM_DIVERSITY , SCM_USAGE

    Scale: 1 < 1 ≤ 2 < 2 ≤ 3 < 3 ≤ 4 < 18 ≤ 5

    Total number of identities found as authors of commits in source code management repositories dated during the last three months.

    Source code management repositories are those considered as such in the project documentation. Commits in all branches are considered. Date used for each commit is 'author date' (when there is a difference between author date and committer date). An identity is considered as author if it appears as such in the commit record (for systems logging several identities related to the commit, authoring identity will be considered). Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

  • File stability index ( SCM_STABILITY_3M )

    Provided by: polarsys_grimoire

    Used by: SCM_STABILITY

    Scale: 1 < 3.79487179487 ≤ 2 < 1.4430952381 ≤ 3 < 1.14285714286 ≤ 4 < 1 ≤ 5

    Average number of commits touching each file in source code management repositories dated during the last three months.

    Source code management repositories are those considered as such in the project documentation. Commits in all branches are considered. A file is 'touched' by a commit if its content or its path are modified by the commit. Date used for each commit is 'author date' (when there is a difference between author date and committer date). Time range is measured as three calendar months period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).