Skip to content

oss-slu/guidebook_tech_debt

Repository files navigation

Codebase Technical Assessment: Guidebook & Rubric

A practical framework for measuring and managing technical debt in software projects. Developed for use in Open Source with SLU experiential learning programs, but applicable to any team that wants to understand and improve code quality systematically.

Contents

  • Guidebook — How to prepare for and conduct technical debt assessments, identify debt, prioritize findings, communicate results, and plan remediation
  • Rubric — Structured scoring framework across code quality dimensions

Who This Is For

  • Tech Leads conducting self-assessments
  • Mentors and advisors evaluating projects
  • New maintainers getting oriented to a codebase
  • Teams preparing for handoffs
  • Anyone wanting to understand technical debt systematically

Usage

These documents are designed to be used together. Start with the Guidebook to understand the assessment process, then apply the Rubric to score specific dimensions of your codebase.

Contributing

If you spot an error or have a suggestion for improvement, feel free to submit a pull request.


License: CC BY-NC-SA 4.0

This work © 2026 by Open Source with SLU, the open source program office of Saint Louis University, is licensed under CC BY-NC-SA 4.0.

About

Practical framework for measuring and managing technical debt in software projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors