NASA-IMPACT / NASA-IMPACT/veda-docs

Documentation Information Alignment Redesign Proposal

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

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
10
Forks
16
Avg merge
2d 31m
Merged PRs (30d)
4

Description

Define a proposed documentation structure aligned to user personas and ensure the service menu (where users discover capabilities) fits that structure without orphan or duplicate paths.

Acceptance Criteria
  • Propose a new documentation hierarchy based on user personas
  • Evaluate and integrate service menu into the new structure

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by mapping the existing documentation hierarchy, user personas, and service menu in the repository. Produce a proposed persona-based structure and show how every service-menu path fits without orphaned or duplicate destinations; done means both acceptance criteria are addressed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.