Skip to content

Update DS Design Documentation and Requirements #160

Description

@chillfig

For requirements

  • Review existing requirements for the module
  • Analyze code for module, code changes/PRs since baseline
  • Compare code with requirements; identify differences
    • If differences, determine if code or requirements contains desired behavior, and/or update the incorrect one (or create a ticket to resolve the code discrepancy)
    • May involve team discussion(s)

For design documentation

  • End product: markdown document (single document for all of CF), using Mermaid for diagrams
  • Sources of information:
    • SRD
    • App Developer's Guide
    • cFS Training
    • Source Code
  • Module section:
    • Overview of Module
    • Behavioral/Structural Views/Algorithms
    • Code Structure
    • Design Decisions, Assumptions, Risks
    • Any Physical Data Models

Metadata

Metadata

Assignees

Labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions