Strategic Refactor: Establish Persona-Based Documentation Paths
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- markdown
調査の方向性
まず PR #249 と、issue で参照されている Slack の投票結果を確認します。既存の .rst および .md ドキュメントを監査し、各ファイルを Legal/Compliance、Security/SCA、または Dev/Integrators のペルソナにタグ付けします。完了条件は、タグ付けしたコンテンツマップ、提案する Sphinx サイトマップ、および少なくとも 2 つのロール向けのユーザージャーニードキュメントを提供することです。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Batchfile
- スター
- 310
- フォーク
- 255
- 平均マージ
- 10時間 5分
- マージ済み PR（30日）
- 1
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
aboutcode-org/aboutcode のほかの issue
-
Cross-reference OpenChain CRA Compliance Checklist再び着手できるかも @PaulitePavitra が 22 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
aboutcode-org/aboutcode#309 · コメント 6 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 30/100
aboutcode-org/aboutcode#314 · コメント 4 件 ·
-
Project: 5C: Continuous Code Compliance Control Center再び着手できるかも @nt5504289-oss が 34 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
難易度 5/5 1週間以上 初心者へのやさしさ 15/100
aboutcode-org/aboutcode#291 · コメント 3 件 ·
-
Remove Projects section in README対応中かも @mjherzog が 246 日前に担当しました。 オープンdocumentation
aboutcode-org/aboutcode#277 · コメント 6 件 · 担当者 1 名 ·
-
RFC: Create AI policy再び着手できるかも @tdruez が 254 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンpolicy
aboutcode-org/aboutcode#265 · コメント 10 件 · 担当者 1 名 ·
aboutcode-org/aboutcode の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
good first issue help wanted Project:Docs workshop
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
メンテナーはふだん 1 日以内に返信
-
good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
auto-rejected intake mcp-intake needs-salvage priority:high type:feature
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
Ikalus1988/MisakaNet#4221 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信