Famille reader-ergonomics

Vérifications contre reader-ergonomics Site

La page d'accueil de la famille reader-ergonomics : la norme, les extensions qui l'appliquent à un genre chacune, le topic sur lequel elles s'appuient, et les deux qui en sortent. Cette page tient la carte, l'état de chaque membre et les règles que les membres partagent ; elle ne tient rien qu'un membre possède. La norme elle-même liste ses extensions et ne dépend d'aucune, donc la carte qui pointe dans les deux sens vit ici.

Cette page en anglais : README.md. Les deux versions suivent le même état.

État (2026-11-03) : version 0.1.0 : la carte, l'état des membres, les six règles écrites, et deux programmes : un audit hebdomadaire de chaque membre et une vérification que les états ci-dessous suivent les étiquettes de GitHub. Ce n'est ni une norme officielle, ni une étude relue par des pairs, ni un résultat nouveau.

Comment il est fait : avec Claude, un assistant IA d'Anthropic, sous la direction du mainteneur, comme reader-ergonomics. Les corrections sont bienvenues sous forme d'issues.

La prendre

La page est faite pour être copiée, pour une famille à vous. Copiez-la depuis une version étiquetée (étiquettes), pour qu'un changement ultérieur ici ne change jamais votre copie.

  1. Copiez README.md comme carte, les rules/ que vous gardez et checks/local/, les deux vérifications et leurs tests, aux mêmes chemins de votre dépôt.

  2. Remplacez le tableau des membres et la carte par vos membres ; gardez une colonne État qui nomme l'étiquette la plus récente de chaque membre.

  3. Ajoutez checks/config.toml avec extends = "reader-ergonomics", comme celui-ci, et listez vos membres sous [family_audit] et [bibliography_keys].

  4. Épinglez la norme par son commit dans chaque workflow, comme checks.yml, puis lancez :

    git clone https://github.com/Tewf/reader-ergonomics
git -C reader-ergonomics checkout 2e5b6f0c3e67d2dc8195a63cf882d46170e79a5a
python3 reader-ergonomics/checks/run.py chemin/vers/votre/depot

  5. Comment prendre votre propre version, et où va un désaccord : la section Take your own version de la norme.

La carte

La norme en bas ; six extensions sur elle : academic, presentations, software-design, learning, review et le topic ; sur le topic, le blueprint et le projet ; le blueprint est le pont vers le hub ai-augmented. Ce hub est au-dessus de tout et rien ne pointe vers lui.
Source Graphviz 
// The map of the reader-ergonomics family. Colours: the family blue, the sibling family green, the bridge orange,
// each kind named in its box; this page, the hub, has the thick border and nothing points to it.
digraph map {
  graph [rankdir=TB, nodesep=0.3, ranksep=0.45, bgcolor="white", pad=0.2, fontname="Inter", newrank=true];
  node  [shape=box, style="rounded,filled", fontname="Inter", fontsize=13, margin="0.2,0.1", penwidth=1.5, fontcolor="#1F2328"];
  edge  [fontname="Inter", fontsize=11, color="#3D434B", fontcolor="#55575F", penwidth=1.3, arrowsize=0.8];
  HUB [label=<<b>reader-ergonomics-family</b><br/><font point-size="11" color="#55575F">the hub: map, states, rules</font>>, fillcolor="#E8EEF8", color="#2F5DA8", penwidth=2.6];
  RE [label=<<b>reader-ergonomics</b><br/><font point-size="11" color="#55575F">the standard, v1.21.0</font>>, fillcolor="#E8EEF8", color="#2F5DA8"];
  AC [label=<<b>academic</b><br/><font point-size="11" color="#55575F">reports, papers, proofs</font>>, fillcolor="#E8EEF8", color="#2F5DA8"];
  PR [label=<<b>presentations</b><br/><font point-size="11" color="#55575F">talks, figures</font>>, fillcolor="#E8EEF8", color="#2F5DA8"];
  SD [label=<<b>software-design</b><br/><font point-size="11" color="#55575F">design documents</font>>, fillcolor="#E8EEF8", color="#2F5DA8"];
  LE [label=<<b>learning</b><br/><font point-size="11" color="#55575F">material to be learned</font>>, fillcolor="#E8EEF8", color="#2F5DA8"];
  RV [label=<<b>review</b><br/><font point-size="11" color="#55575F">the literature review as a genre</font>>, fillcolor="#E8EEF8", color="#2F5DA8"];
  T  [label=<<b>topic</b><br/><font point-size="11" color="#55575F">the recursive unit</font>>, fillcolor="#E8EEF8", color="#2F5DA8"];
  BP [label=<<b>blueprint</b><br/><font point-size="11" color="#55575F">the bridge: reasoning checked</font>>, fillcolor="#FBEDE4", color="#B4541A"];
  P  [label=<<b>project</b><br/><font point-size="11" color="#55575F">one person's project, as topics</font>>, fillcolor="#E8EEF8", color="#2F5DA8"];
  AI [label=<<b>ai-augmented</b><br/><font point-size="11" color="#55575F">the sibling family's hub</font>>, fillcolor="#E6F2EA", color="#2E7D4F"];
  HUB -> RE [style=invis];
  RE -> AC [dir=back, label=" extends"];
  RE -> PR [dir=back, label=" extends"];
  RE -> SD [dir=back, label=" extends"];
  RE -> LE [dir=back, label=" extends"];
  RE -> T [dir=back, label=" extends"];
  RE -> RV [dir=back, label=" extends"];
  T -> BP [dir=back, label=" builds on"];
  T -> P [dir=back, label=" builds on"];
  BP -> AI [dir=back, style=dashed, label=" the bridge to"];
  {rank=same; AC; PR; SD; LE; T; RV}
  {rank=same; BP; P}
}
Membre Problème État
reader-ergonomics la norme : des principes gradés par leur preuve, des formes à remplir, des vérifications à lancer sur tout texte v1.21.0, déclarée finie
reader-ergonomics-academic rapports, articles de recherche, articles mathématiques et preuves v1.0.0
reader-ergonomics-presentations exposés, et la figure ou le diagramme dans tout document v1.0.0
reader-ergonomics-software-design les documents qui conçoivent un logiciel avant le code v1.0.0
reader-ergonomics-learning le matériel fait pour être appris v1.0.0
reader-ergonomics-review la revue de littérature comme genre : ses étapes, ses fichiers, sa notation grise, son second évaluateur et son flux périmètre posé le 2026-11-03 ; première revue non commencée
reader-ergonomics-topic une unité d'écriture récursive, le topic, et sa vérification v0.6.1
reader-ergonomics-blueprint le raisonnement en arbre de topics, un vérificateur par partie, Lean d'abord, un modèle qui oriente B1 en miniature construit : le théorème d'Euclide en topics, Lean vert en CI
reader-ergonomics-project comment une personne mène un projet, chaque étape un topic revue faite (38 sources) ; la forme du projet et sa vérification

Les deux derniers membres sortent de cette famille. Le blueprint est le pont vers la famille AI-augmented, où une personne, un modèle et une machine partagent un projet. Le projet y a son pendant, ai-augmented-project.

Les règles

  • La norme ne dépend d'aucune extension. Une extension lie les principes et les formes de la norme à une version, épinglée par commit dans chaque workflow, et ne les copie jamais. La norme peut lister une extension, jamais la lire (extending.md).
  • Un genre par extension, et seulement ce que le genre change : un principe que la norme tient déjà est lié.
  • Chaque membre exécute les vérifications de la norme en CI, et les siennes dans checks/local/. Une vérification écrite par une extension est proposée à la norme une fois qu'elle tient sur la famille. Chaque membre l'exécute alors dès sa prochaine montée d'épingle.
  • Chaque propriétaire de genre audite toute la famille dans son genre ; un constat va au dépôt propriétaire comme issue, jamais comme push.
  • Une montée d'épingle est une ligne de changelog, pas une fiche de décision, et elle déplace tous les workflows à la fois.
  • Chaque membre a une version qu'un lecteur peut copier, avec un bloc « prenez-la » sur sa page d'accueil.

Le premier travail

Fait le 2026-11-02, en première passe : les règles en pages, l'audit en programme lancé chaque semaine par family-audit.yml, et la vérification de la carte.

  1. Les règles, écrites. Les six règles ci-dessus sont tenues dans les notes du mainteneur et dans l'extending.md de la norme. Ici elles reçoivent une page chacune, avec leur raison et leur histoire, liée depuis les membres.
  2. L'audit de la famille comme programme. Le 2026-10-29, chaque propriétaire de genre a audité la famille à la main et avec un script par genre. Le travail est un programme qui lance les vérifications de chaque membre sur chaque membre et rapporte, pour que l'audit soit répété par la CI plutôt que retenu de mémoire.
  3. La carte tenue à jour par une vérification : l'épingle, la version et l'état de chaque membre sur cette page comparés à ce que GitHub tient, pour que la page ne vieillisse pas en silence.

Vérifier

L'audit de la famille et la vérification de la carte tournent chaque semaine. À la main, depuis ce dépôt :

python3 -m unittest discover -s checks/local
python3 checks/local/family_audit.py --standard chemin/vers/reader-ergonomics
python3 chemin/vers/reader-ergonomics/checks/run.py . --online --only map-true

Pour vérifier ce dépôt lui-même :

git clone https://github.com/Tewf/reader-ergonomics
python3 reader-ergonomics/checks/run.py chemin/vers/ce/depot

La CI exécute les mêmes vérifications à chaque push, et une exécution échoue à la première erreur (checks.yml). Chaque push sur master construit aussi le site, tewf.github.io/reader-ergonomics-family (pages.yml).

Contenu

Partie Résumé
rules les six règles communes, une page chacune avec sa raison et son histoire
checks/local l'audit de la famille et la vérification de la carte, avec leurs tests
decisions une fiche par choix qui façonne ce dépôt, chacune ouvrant sur la décision en une phrase

Licence

Code sous Apache License 2.0 ; prose sous CC BY 4.0. Réutilisez-le comme vous le souhaitez, en créditant ce dépôt ; CITATION.cff donne une citation si besoin.