FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Add User Roles documentation (Issue #223) by im-anishraj · Pull Request #243 · aboutcode-org/aboutcode · GitHub

/ aboutcode Public

Add User Roles documentation (Issue #223) #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
im-anishraj wants to merge 1 commit into
base: main
Choose a base branch
Could not load branches
Branch not found: {{ refName }}

Are you sure you want to change the base?

Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
from
Conversation 0 Commits 1 Checks 1 Files changed
Open

Add User Roles documentation (Issue #223) #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
1 change: 1 addition & 0 deletions docs/source/index.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Overview
:maxdepth: 3

aboutcode-project-overview
user_roles

************
Contributing
Expand Down
56 changes: 56 additions & 0 deletions docs/source/user_roles.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -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.
Back | FazBrowse Home | New Git URL