Organize documentation using the dry principle and ark42 #49

New Issue

tegwick · 2025-09-30T22:12:36Z

tegwick commented

2025-09-30 22:12:36 +00:00

We should neither duplicate code nor documentation.
This is where we engage the DRY principle for documenting our project.

As it is an IT System and quite sophisticated and because I like the ark42 framework, let's try to use it if things get complicated.

Maybe we should spawn an issue for the ark42 stuff.

For starters put classic baseline documentation in place and in order:

README.md
CONFIG.md
LICENSE.md
TESTING.md

whatever

CONCEPT.md maybe

We should neither duplicate code nor documentation. This is where we engage the DRY principle for documenting our project. As it is an IT System and quite sophisticated and because I like the ark42 framework, let's try to use it if things get complicated. Maybe we should spawn an issue for the ark42 stuff. For starters put classic baseline documentation in place and in order: - README.md - CONFIG.md - LICENSE.md - TESTING.md whatever - CONCEPT.md maybe

tegwick added this to the Clean Repository Standard project 2025-09-30 22:12:36 +00:00

tegwick changed title from ~~Organize docuementation using the dry principle and ark42~~ to Organize documentation using the dry principle and ark42

2025-10-02 02:56:34 +00:00

tegwick referenced this issue

2025-10-02 19:36:21 +00:00

Issue #49.1: Create missing baseline documentation files (LICENSE.md, TESTING.md, CONCEPT.md) #74

tegwick referenced this issue

2025-10-02 19:36:36 +00:00

Issue #49.2: Enhance README.md structure and navigation #75

tegwick referenced this issue

2025-10-02 19:36:53 +00:00

Issue #49.3: Organize development documentation (move diaries, reports, guides to docs/ subdirs) #76

tegwick referenced this issue

2025-10-02 19:37:11 +00:00