From 53a8b2d969b4062062136a64ada00ec38985ffb8 Mon Sep 17 00:00:00 2001 From: anish-devgit Date: Tue, 13 Jan 2026 17:43:50 +0530 Subject: [PATCH] Add User Roles documentation (Issue #223) Signed-off-by: anish-devgit --- docs/source/index.rst | 1 + docs/source/user_roles.rst | 56 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 docs/source/user_roles.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index e13bf63..1126794 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -26,6 +26,7 @@ Overview :maxdepth: 3 aboutcode-project-overview + user_roles ************ Contributing diff --git a/docs/source/user_roles.rst b/docs/source/user_roles.rst new file mode 100644 index 0000000..4f2113d --- /dev/null +++ b/docs/source/user_roles.rst @@ -0,0 +1,56 @@ +.. _user_roles: + +User Roles +========== + +AboutCode tools serve a diverse group of users with varying needs, technical backgrounds, and objectives. This document identifies the primary user roles to help tailor documentation and features more effectively. + +Developer +--------- +**Attributes:** +* **Technical Level:** High. Comfortable with command-line interfaces, APIs, and building from source. +* **Job Title:** Software Engineer, Open Source Maintainer, DevOps Engineer. +* **Objectives:** + * Integrate ScanCode or other tools into CI/CD pipelines. + * Contribute code fixes or new features to AboutCode projects. + * Automate software composition analysis. + +Compliance Officer +------------------ +**Attributes:** +* **Technical Level:** Low to Moderate. Focuses on policy, legal obligations, and risk management. +* **Job Title:** Open Source Program Office (OSPO) Manager, Legal Counsel, Compliance Manager. +* **Objectives:** + * Ensure all software components have compatible licenses. + * Generate compliance artifacts (Attributions, BOMs). + * Understand license obligations and risks. + +Security Analyst +---------------- +**Attributes:** +* **Technical Level:** Moderate to High. Focuses on vulnerabilities and software supply chain security. +* **Job Title:** Security Researcher, Application Security Engineer. +* **Objectives:** + * Identify known vulnerabilities (CVEs) in software dependencies. + * Track the origin and provenance of code components. + * Respond to security advisories and patch requests. + +Product Manager +--------------- +**Attributes:** +* **Technical Level:** Moderate. Focuses on product roadmap and external dependencies. +* **Job Title:** Product Manager, Technical Lead. +* **Objectives:** + * Understand the software bill of materials (SBOM) for their product. + * Evaluate the health and maintenance status of open source dependencies. + * Make decisions about which components to include in the product. + +Student / Researcher +-------------------- +**Attributes:** +* **Technical Level:** Varying (Novice to Expert). Learning about SCA and software licensing. +* **Job Title:** Student, Academic Researcher. +* **Objectives:** + * Learn how Software Composition Analysis works. + * Analyze datasets of open source packages for research. + * Understand the landscape of open source licensing.