eclipse-score / eclipse-score/score

Work products have to be available and valid

Open
#3,043 0 comments 0 reactions 0 assignees View on GitHub
quality
Dominant language
Starlark
Stars
109
Forks
105
Avg merge
1d 9h
Merged PRs (30d)
21

Description

Compare with https://eclipse-score.github.io/score/main/platform_management_plan/documentation_management.html all work products have to be available and valid. Deviations found in

Status draft:
- API Guidelines
- MISRA C++:2023 Rule Mapping
- Rust API design guidelines
- Configuration Management Plan
- Platform Management Plan
- Problem Resolution Plan
- Release Management Plan
- Platform Safety Plan
- Platform Security Plan
- Platform Vulnerability Management Plan
- SW-platform Assumptions
- SW-platform stakeholder requirements
- Safety Analysis Formal Review Report
- Platform Safety Package Formal Review
- S-CORE Platform Safety Plan Formal Review
- Platform DFA
- Platform Safety Manual
- Bazel
- gcc
- Doc-as-Code
- gtest
- ITF
- github
- Tool Evaluation List
- Communication IPC Safety WPs
- IPC DFA
- IPC FMEA
- FEO Feature Architecture Inspection Checklist
- FEO Assumptions of Use Requirements
- FEO Feature DFA
- FEO Feature FMEA
- FEO Feature Requirements Inspection Checklist
- FEO Feature Safety Analysis Inspection Checklist
- Orchestration Architecture
- Orchestration DFA
- Orchestration FMEA
- Orchestration Safety WPs
- Communication Safety Manual
- Communication Safety Package Formal Review
- Communication Safety Plan
- Communication Safety Plan Formal Review
- Communication Verification Report
- LoLa
- LoLa Architecture
- lola Component Classification
- LoLa Detailed Design
- lola DFA
- lola FMEA
- LoLa Requirements
- FEO Component Architecture Inspection Checklist
- FEO Component Assumptions of Use Requirements
- FEO Component Architecture
- FEO Component Detailed Design
- FEO Component DFA
- FEO FMEA
- FEO Component Requirements
- FEO Component
- FEO Component Classification
- FEO Module Safety Manual
- FEO Module Safety Package Formal Review
- FEO Module Safety Plan Formal Review
- FEO Module Verification Report
- FEO Implementation Inspection Checklist
- FEO Component Requirements Inspection Checklist
- FEO Safety Analysis Inspection Checklist
- Operating System Assumptions of Use
- QNX Assumptions of Use
- [OS Name]
- Operating System Requirements

Not available:
- Glossary
- handbook
- manuals
- security

This is only a snapshot created out of the documentation management plan.

Proposal:
- Assign sub-tickets to feature teams to update documentation acc. to https://eclipse-score.github.io/score/main/contribute/general/folder.html
- Assign sub-tickets for the platform
- Close the gaps by checking against expectations
- Perform FDRs for release

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by comparing the documentation management plan with the listed draft and unavailable work products, then review the folder guidance in the linked documentation. Done means the gaps are assigned to feature or platform sub-tickets, checked against the stated expectations, and addressed for release FDRs.

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
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.