DOCS: User validation of ScanCode and VulnerableCode docs improvements

Open
#51 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript, markdown
Domain
documentation

Research direction

Start by reading the documentation changes referenced in aboutcode-org/www.aboutcode.org issues #39 and #41 for ScanCode and VulnerableCode. The work is to conduct user testing with community members, capture feedback on whether the docs improved user experience, and identify or implement follow-up documentation improvements.

Written by the indexing model from the issue text.

Description

documentation

Conduct user testing with community members who utilize ScanCode and/or VulnerableCode to validate recent documentation changes in:

The goal is to ensure that these updates have effectively improved user experience and to identify any additional enhancements needed. This testing will help us capture feedback and implement follow-up improvements based on real user interactions.

Dominant language
JavaScript
Stars
9
Forks
18
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aboutcode-org/www.aboutcode.org

All issues in aboutcode-org/www.aboutcode.org

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.