Aller au contenu

Documentation Architecture Review

Purpose

This document tracks the architecture review of the CMonChoix Platform documentation.

The goal is not to rewrite the documentation from scratch.

The goal is to transform the existing docs/ directory into a governed, scalable, industrial documentation system.

Current Findings

P0 - Duplicate Document

docs/architecture/dependances.md and docs/architecture/identifier-first.md currently contain identical content.

Decision required:

  • keep dependances.md as the dependency document;
  • rewrite identifier-first.md as the official Identifier First architecture document.

P0 - Governance Root Clarification

docs/governance.md and docs/governance/index.md must keep distinct responsibilities:

  • docs/governance.md defines stable governance rules;
  • docs/governance/index.md is the entry point for detailed Governance documents.

P1 - ADR Location Ambiguity

ADR documents currently exist in multiple locations:

  • docs/adr/
  • docs/architecture/adr/

Decision required:

  • define one official ADR location;
  • recommended location: docs/adr/.

P1 - Weak Overview Documents

Several overview.md files are too small to act as proper entry points.

Each overview should define:

  • purpose;
  • responsibility;
  • scope;
  • non-goals;
  • related documents.

P1 - Stub Documents

Several documents contain only placeholder-level content.

Decision required:

  • enrich;
  • merge;
  • or archive after replacement.

P1 - Platform / WordPress Boundary

Some documents still mix Platform architecture with WordPress/plugin concerns.

  • Platform documentation must describe the Platform;
  • WordPress documentation must only describe the Adapter or operations.

Review Rules

Each document will be classified as one of:

  • KEEP
  • IMPROVE
  • MOVE
  • MERGE
  • SPLIT
  • ARCHIVE
  • REPLACE

No document is deleted without audit, replacement, or explicit archival decision.

Next Review Step

Build a complete document inventory with classification, priority, and remediation action.