Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Strategic Refactor: Establish Persona-Based Documentation Paths

Aperta
  • Qualcosa non va?
#250 11 commenti 0 reazioni 0 assegnatari Vedi su GitHub

@IQRAZAM ci sta già lavorando.

Dal 21/2/2026.

  • #260 di @gyanranjanpanda — aperta

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

Inizia esaminando la PR #249 e i risultati del sondaggio Slack citati nell’issue. Verifica la documentazione esistente in .rst e .md, assegnando a ogni file la persona Legal/Compliance, Security/SCA o Dev/Integrators. Il lavoro sarà considerato completato quando saranno forniti una mappa dei contenuti con i tag, una proposta di mappa del sito Sphinx e documenti del percorso utente per almeno due ruoli.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

Problem Statement: Currently, the AboutCode documentation is structured primarily around tool functionality. However, our ongoing research into User Roles (see PR #249) indicates that our audience is split between highly technical developers, legal compliance officers, and security researchers. Each of these groups has different "information hunger" and entry points.

Proposal: Conduct a comprehensive audit of the existing documentation to map current content against the newly defined personas:

  • Legal/Compliance: High-level summaries, license policy guides, and reporting features.

  • Security/SCA: Vulnerability database integration and scanning workflows.

  • Dev/Integrators: CLI usage, API documentation, and CI/CD pipeline integration.

  • Goals:

    • Identify Gaps: Determine which roles are currently underserved by the documentation.
    • Navigation Overhaul: Propose a "Choose Your Own Adventure" style landing page for docs.aboutcode.org.
    • Language Consistency: Ensure that non-technical roles aren't hit with jargon in the introductory sections.

  • Acceptance Criteria:

    • A spreadsheet or map of existing .rst/.md files tagged by target persona.
    • A proposed new Site Map for the Sphinx documentation.
    • A "User Journey" document for at least two primary roles (e.g., a first-time Compliance Officer vs. a Senior DevOps Engineer).

  • Additional Context: This issue will directly consume the results of the Slack poll initiated in #249 to ensure the reorganization is data-driven.

Lingua principale
Batchfile
Stelle
310
Fork
255
Merge medio
10h 5m
PR unite (30g)
1

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di aboutcode-org/aboutcode

Tutte le issue di aboutcode-org/aboutcode

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.