Documentation Metrics


All metrics used in the quality model are described thereafter, with useful information and references. They are classified according to their source. Please note also that several other metrics may be retrieved but not used in the quality model.



  • Access information ( PMI_ACCESS_INFO )

    Provided by: EclipsePmi

    Used by: QM_SUPPORT

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

    Is the access info (downloads, update sites..) correctly filled in the PMI records?

    The project management infrastructure file holds information about how to access binaries of the project. This test checks the number of access-related entries defined in the PMI: download_url, downloads, update_sites.

  • Doc information ( PMI_DOC_INFO )

    Provided by: EclipsePmi

    Used by: QM_SUPPORT

    Scale: 1 < 0 ≤ 2 < 2 ≤ 3 < 4 ≤ 4 < 6 ≤ 5

    Is the documentation info correctly filled in the PMI records?

    The project management infrastructure file holds information about various documentation and manuals. This test checks the number of doc-related entries defined in the PMI: build_doc, documentation, documentation_url, forums, gettingstarted_url, mailing_lists, website_url, wiki_url.

  • ITS information ( PMI_ITS_INFO )

    Provided by: EclipsePmi

    Used by: QM_SUPPORT

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

    Is the bugzilla info correctly filled in the PMI records?

    The project management infrastructure file holds information about one or more bugzilla instances. This test checks that at least one bugzilla instance is defined, with a product identifier, a create_url to enter a new issue, and a query_url to fetch all the issues for the project.

  • Number of releases ( PMI_REL_VOL )

    Provided by: EclipsePmi

    Used by: QM_REL_ENG

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

    The number of releases recorded in the PMI.

    Milestones are retrieved from the PMI file and are counted whatever their target release is. Milestones are useful to assess the maturity of the release and improves predictability of the project's output, in terms of quality and time.

  • SCM information ( PMI_SCM_INFO )

    Provided by: EclipsePmi

    Used by: QM_SCM , QM_SUPPORT

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

    Is the source_repo info correctly filled in the PMI records?

    The project management infrastructure file holds information about one or more source repositories. This test checks that at least one source repository is defined, and accessible.


Page generated by Alambic 3.3.2 on Wed Oct 18 18:06:02 2017.