A process practice to validate the quality of reused component documentation: a case study involving open-source components
Bibliographic record
Abstract
The poor quality of the documentation of some reused components can jeopardize the success of a project. This paper aims to assess the impact of reused components documentation quality on the effort required to complete a software evolution project and to propose a process practice to reduce the risk associated to the integration of reused components. A case study is based on data gathered from a capstone project requiring a total effort of roughly 1800 person-hours. Participant activities are self-recorded on an hourly basis. The main issues are related to imprecise and inaccurate documentation of the reused open-source components and the extra effort required dealing with these flaws. To maximize components reuse benefits, it is recommended to add a process practice enforcing early reusable components validation. This new practice would provide feedback to the software architect regarding the quality of the selected reused components.
Fetched live from OpenAlex and de-inverted. Abstracts are not stored in this database: the inverted indexes are 8.6 GB of the frame’s 9.3 GB of text, and the host has 13 GB free.
How this classification was reachedexpand
Full frame machine prediction
Teacher imitationNot calibrated prevalence, not ground truth. Human validation pending. The Gemma side is a direct model label for every work in the frame, read from the title-only record. The Codex side is a classifier learned from the 10,348 direct Codex labels and calibrated to design-weighted sample rates; fields without enough sample support carry no Codex call. Candidate is the union of the two sides; consensus is their intersection. These outputs are machine_predicted_unvalidated and are not human labels.
Distilled classifier scores by category (both heads)
| Category | Codex | Gemma |
|---|---|---|
| Metaresearch | 0.066 | 0.115 |
| Meta-epidemiology (narrow) | 0.001 | 0.001 |
| Meta-epidemiology (broad) | 0.001 | 0.001 |
| Bibliometrics | 0.003 | 0.002 |
| Science and technology studies | 0.005 | 0.005 |
| Scholarly communication | 0.004 | 0.006 |
| Open science | 0.003 | 0.006 |
| Research integrity | 0.003 | 0.002 |
| Insufficient payload (model declined to judge) | 0.001 | 0.000 |
Machine scores (provisional)
The two teacher heads of the student model, read on this work. A score orders the frame for review; it never asserts a category, and the validation status ships verbatim with every row.
Baseline scores from an immature model (maturity gate not passed, 7 training rounds). Scores rank; they never assert a category.
score_only:v0-immature-baseline · verbatim from the scoring run: score_only means the number may rank works, and no category label ships from itClassification
machine, unvalidatedMachine predicted; a candidate call from one source (direct Gemma or distilled Codex), not a consensus.
How this classification was reached, model by model and score by score, is at the end of the page under "How this classification was reached".