Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Strategic Refactor: Establish Persona-Based Documentation Paths

Offen
  • Stimmt etwas nicht?
#250 11 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

@IQRAZAM arbeitet bereits daran.

Seit 21.2.2026.

  • #260 von @gyanranjanpanda — offen

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Tech-Stack
markdown
Bereich
documentation

Rechercherichtung

Beginnen Sie mit der Durchsicht von PR #249 und der im Issue referenzierten Slack-Umfrage. Prüfen Sie die vorhandene Dokumentation im Format .rst und .md und kennzeichnen Sie jede Datei mit der Persona Legal/Compliance, Security/SCA oder Dev/Integrators. Als erledigt gilt die Aufgabe, wenn eine gekennzeichnete Inhaltsübersicht, ein vorgeschlagener Sphinx-Sitemap-Entwurf und User-Journey-Dokumente für mindestens zwei Rollen bereitgestellt wurden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
Batchfile
Sterne
310
Forks
255
Ø Merge
10 Std. 5 Min.
Gemergte PRs (30 T.)
1

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus aboutcode-org/aboutcode

Alle Issues in aboutcode-org/aboutcode

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.