Dings-Feature-Design

I am a Feature.

Also

- I am a Todo.

- I am a Work-Item.

About

• My State is Done.

Goal

The Goal of this Work-Item is to introduce central Design-Documentation for the Dings-System.

The Design-Documentation shall describe the current intended Design of the Dings-System and shall help to keep Documentation, Code and Use-Cases consistent.

Design-Documents

This Work-Item works on the following Design-Documents:

• All-Dings-Overview
• All-Dings-HLD
• All-Dings-LLD
• Dings-English
• Dings-Coding-Style

Design-Layers

The Design of the Dings-System is documented in three Layers:

• All-Dings-Overview
• All-Dings-HLD
• All-Dings-LLD

All-Dings-Overview

The All-Dings-Overview describes the Top-Level-Design of the Dings-System.

It describes:

• Mission
• Goals
• Core Concepts
• Core Principles
• Main Use-Cases

All-Dings-HLD

The All-Dings-HLD describes the High-Level-Design of the Dings-System.

It describes:

• Main System Areas
• User-visible Semantics
• Command Families
• Main Data-Flows
• Stable Terms

All-Dings-LLD

The All-Dings-LLD describes the Low-Level-Design of the Dings-System.

It describes:

• Internal Data-Structures
• Parsers
• Resolvers
• Maps
• Json Files
• Command Implementation Details
• Test Strategy

Work-Item-Documents

Work-Item-Documents describe historical Development Steps.

They describe:

• Start Situation
• Goals
• Design Ideas during Development
• Realized Result
• Changed Files
• Use-Cases
• Commits

After Completion, Work-Item-Documents are not updated for every later Design Change.

If the Design changes later, a new Work-Item documents the Change and the current Design-Documents are updated.

First Design-Area

The first concrete Design-Area is:

• dings-gpt show sm

This includes:

• sm1
• sm2
• Resolver
• list
• where
• claims-from
• names-of

Current Result

The general HLD/LLD Split has been prepared:

• All-Dings-HLD describes the high-level System-View.
• All-Dings-LLD describes concrete Directories, Files, Commands and Implementation-Details.

The first Representation-Layers are documented:

• md
• ir
• sm1
• sm2

The first HLD Content for dings-gpt show sm is documented in All-Dings-HLD.

The first LLD Content for dings-gpt show sm is documented in All-Dings-LLD.

The current LLD Content for dings-gpt show sm includes:

• Pipeline
• Json Artifacts and Structures
• Target-Resolution
• dings
• list
• where
• names-of
• claims-from
• relevant All-Dings.sm2.json Maps
• Debug-Output

Acceptance-Criteria

This Work-Item is done when:

• The Role of the All-Dings-Overview is clear.
• The Role of the All-Dings-HLD is clear.
• The Role of the All-Dings-LLD is clear.
• The Role of Work-Item-Documents is clear.
• The first HLD Content for dings-gpt show sm exists.
• The first LLD Content for dings-gpt show sm exists.