Skip to content

Commit bb0f248

Browse files
committed
Align project docs with checked-in code
1 parent 0b85fa1 commit bb0f248

108 files changed

Lines changed: 1531 additions & 177 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/ar/projects/project-01-baseline-vs-minimal-harness/index.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
ستنفذها مرتين. المرة الأولى: prompt فقط، دون تحضير. المرة الثانية: مع وضع `AGENTS.md` و `init.sh` و `feature_list.json` مسبقًا في المستودع. ثم قارن.
1313

14-
جوهر هذا المشروع ليس كتابة الكود، بل قياس الفرق بين "قضاء 15 دقيقة في تحضير القواعد أولًا" و"ترك الوكيل يعمل مباشرة".
14+
يستخدم سيناريو الدورة هذا فترة قصيرة من إعادة الاكتشاف/التحضير كمثال، لا كنتيجة قياس ثابتة.
1515

1616
## الأدوات
1717

@@ -23,3 +23,14 @@
2323
## آلية harness
2424

2525
Harness بسيط: `AGENTS.md` + `init.sh` + `feature_list.json`
26+
27+
## استخدم المشروع المضمَّن في المستودع
28+
29+
مسار المشروع في المستودع: `projects/project-01/`
30+
31+
| المجلد | ماذا يحتوي | كيف تستخدمه / ماذا تقارن |
32+
|------|------|------|
33+
| `starter/` | تشغيل الـ harness الضعيف. يحتوي فقط على `task-prompt.md` كوصف للمهمة ولا يتضمن `AGENTS.md` أو `feature_list.json`. | قدّم الـ prompt لوكيلك وقِس ما الذي ينجزه بدون أي هيكلة إضافية. |
34+
| `solution/` | نفس جزء المنتج مع ملفات harness صريحة: `AGENTS.md` و`CLAUDE.md` و`init.sh` و`feature_list.json` و`claude-progress.md`. | قارن كيف تجعل القواعد والتحقق نفس المهمة قابلة للتنفيذ والقياس. |
35+
36+
الميزات الأربع الملموسة هي: تشغيل النافذة، قائمة المستندات، لوحة الأسئلة/الأجوبة، وإنشاء مجلد البيانات المحلي. راجع `solution/feature_list.json` لمعرفة الدليل المتوقع لكل ميزة.

docs/ar/projects/project-02-agent-readable-workspace/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@
1111

1212
ستنفذه مرتين: الأولى دون مساعدة، والثانية مع وضع `ARCHITECTURE.md` و `PRODUCT.md` و `session-handoff.md` مسبقًا في المستودع.
1313

14+
## استخدم المشروع الموجود في المستودع
15+
16+
مسار المستودع: `projects/project-02/`
17+
18+
| المجلد | ماذا يحتوي | ماذا تقارن |
19+
|------|------|------|
20+
| `starter/` | كود Project 01 مع import المستندات، عرض التفاصيل، و persistence غير مكتملة بعد. توجد وثائق لكنها أخف، ولا يوجد `session-handoff.md`. | مقدار السياق الذي تحتاج الجلسة الثانية من الوكيل إلى اكتشافه من جديد. |
21+
| `solution/` | نفس جزء المنتج مكتمل، مع وثائق handoff تحت `projects/project-02/solution/`، بالإضافة إلى `feature_list.json` و `session-handoff.md`. | هل تستطيع جلسة جديدة المتابعة اعتمادًا على حالة المستودع فقط. |
22+
1423
## الأدوات
1524

1625
- Claude Code أو Codex

docs/ar/projects/project-03-multi-session-continuity/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@
1111

1212
ستنفذه مرتين: الأولى دون قيود، والثانية مع تطبيق صارم.
1313

14+
## استخدم المشروع الموجود في المستودع
15+
16+
مسار المستودع: `projects/project-03/`
17+
18+
| المجلد | ماذا يحتوي | ماذا تقارن |
19+
|------|------|------|
20+
| `starter/` | كود Project 02 وفيه indexing و Q&A مع citations غير مكتملين بعد. يوجد `feature_list.json` أولي، لكن لا توجد ملفات handoff/restart النهائية. | هل ينحرف الوكيل بين عدة ميزات أو يفقد الحالة بعد إعادة التشغيل. |
21+
| `solution/` | chunking و metadata و index status و citation-based Q&A مكتملة، مع `init.sh` و `session-handoff.md` و `claude-progress.md` و `clean-state-checklist.md`. | هل تملك كل ميزة دليل تحقق قبل وضعها في حالة pass. |
22+
1423
## الأدوات
1524

1625
- Claude Code أو Codex

docs/ar/projects/project-04-incremental-indexing/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@
1111

1212
ستنفذه مرتين: الأولى دون سجلات أو قيود، والثانية بالأدوات والقواعد المناسبة.
1313

14+
## استخدم المشروع الموجود في المستودع
15+
16+
مسار المستودع: `projects/project-04/`
17+
18+
| المجلد | ماذا يحتوي | ماذا تقارن |
19+
|------|------|------|
20+
| `starter/` | كود Project 03 مع إشارات تشخيص ضعيفة. عيب indexing المزروع قد يكسر chunking للملفات الكبيرة، ولا يوجد script لفحص المعمارية. | كم يستغرق الوكيل للوصول إلى السبب الجذري بدون إشارات runtime. |
21+
| `solution/` | structured logger، وثائق/script لحدود المعمارية، منطق chunking مصحح، و `clean-state-checklist.md`. | هل تجعل logs و boundary checks الإصلاح أسرع وأقل تدخلاً. |
22+
23+
ملفات مهمة: `projects/project-04/solution/src/services/logger.ts`, `projects/project-04/solution/scripts/check-architecture.sh`, `projects/project-04/solution/docs/ARCHITECTURE.md`, `projects/project-04/solution/src/services/indexing-service.ts`.
24+
1425
## الأدوات
1526

1627
- Claude Code أو Codex

docs/ar/projects/project-05-grounded-qa-verification/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@
1111

1212
اختر ترقية جوهرية لميزة، مثل محادثة متعددة الأدوار، أو إعادة تصميم لوحة الاستشهادات، أو فلترة المستندات، وحافظ عليها ثابتة في كل التشغيلات.
1313

14+
## استخدم المشروع الموجود في المستودع
15+
16+
مسار المستودع: `projects/project-05/`
17+
18+
| المجلد | ماذا يحتوي | ماذا تقارن |
19+
|------|------|------|
20+
| `starter/` | تطبيق مبني على Project 04 قبل ترقية سجل المحادثة. | نقطة البداية إذا أردت إعادة تشغيل المتغيرات الثلاثة. |
21+
| `solution/single-role/` | وكيل واحد يخطط وينفذ ويقيّم نفسه. | الدرجة والعيوب في `evaluator-rubric.md`. |
22+
| `solution/gen-eval/` | generator + evaluator مع دليل مراجعة. | الدرجة وملاحظات revision في `evaluator-rubric.md`. |
23+
| `solution/plan-gen-eval/` | planner + generator + evaluator مع sprint contract. | `sprint-contract.md` ودليل الدرجة الأعلى في `evaluator-rubric.md`. |
24+
1425
## الأدوات
1526

1627
- Claude Code أو Codex

docs/ar/projects/project-06-runtime-observability-and-debugging/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@
1111

1212
استخدم مجموعة مهام ثابتة متعددة الميزات تغطي شريحة منتج كاملة: استيراد المستندات، الفهرسة، Q&A مع الاستشهادات، قابلية ملاحظة runtime، وحالة مستودع قابلة للقراءة والاستئناف. ابدأ بتشغيل baseline مع harness ضعيف، ثم شغّل أقوى harness لديك، ثم نظف وأعد التشغيل. أخيرًا، نفذ تجربة ablation للـ harness: أزل مكونًا واحدًا كل مرة وانظر أيها مهم فعليًا.
1313

14+
## استخدم المشروع الموجود في المستودع
15+
16+
مسار المستودع: `projects/project-06/`
17+
18+
| المجلد | ماذا يحتوي | ماذا تقارن |
19+
|------|------|------|
20+
| `starter/` | المنتج شبه مكتمل، لكن سطح harness ضعيف عمدًا: يوجد `AGENTS.md` أساسي فقط، ولا يوجد `feature_list.json` أو `session-handoff.md` أو clean-state checklist أو benchmark/cleanup scripts. | ملاحظات يدوية لخط baseline مع harness ضعيف. |
21+
| `solution/` | harness كامل: `AGENTS.md`, `CLAUDE.md`, `feature_list.json`, `init.sh`, `session-handoff.md`, `clean-state-checklist.md`, quality/evaluator docs و scripts. | شغّل `projects/project-06/solution/scripts/benchmark.sh` و `projects/project-06/solution/scripts/cleanup-scanner.sh` ثم قارن أدلة الجودة. |
22+
1423
## الأدوات
1524

1625
- Claude Code أو Codex

docs/de/projects/project-01-baseline-vs-minimal-harness/index.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Baue das minimale Gerüst einer Electron-Wissensdatenbank-App: ein Fenster mit D
1111

1212
Du führst sie zweimal aus. Beim ersten Mal: nur ein Prompt, keine Vorbereitung. Beim zweiten Mal: `AGENTS.md`, `init.sh` und `feature_list.json` liegen bereits im Repository. Danach vergleichst du.
1313

14-
Der Kern dieses Projekts ist nicht das Schreiben von Code, sondern herauszufinden, wie groß der Abstand zwischen "15 Minuten Regeln vorbereiten" und "den Agenten einfach loslaufen lassen" ist.
14+
Dieses Kursbeispiel nutzt eine kurze Wiederentdeckungs-/Vorbereitungsphase als Beispiel, nicht als fest gemessenes Ergebnis.
1515

1616
## Werkzeuge
1717

@@ -23,3 +23,14 @@ Der Kern dieses Projekts ist nicht das Schreiben von Code, sondern herauszufinde
2323
## Harness-Mechanismus
2424

2525
Minimaler harness: `AGENTS.md` + `init.sh` + `feature_list.json`
26+
27+
## Nutze das eingecheckte Projekt
28+
29+
Repository-Pfad: `projects/project-01/`
30+
31+
| Verzeichnis | Inhalt | Nutzung/Vergleich |
32+
|------|------|------|
33+
| `starter/` | Weak-Harness-Lauf. Enthält nur `task-prompt.md` als Aufgabenbeschreibung und keine `AGENTS.md` oder `feature_list.json`. | Gib den Prompt an deinen Agenten und miss, was ohne zusätzliche Struktur fertig wird. |
34+
| `solution/` | Gleicher Produktslice mit expliziten Harness-Artefakten: `AGENTS.md`, `CLAUDE.md`, `init.sh`, `feature_list.json` und `claude-progress.md`. | Vergleiche, wie Regeln und Verifikation die gleiche Aufgabe konkret und überprüfbar machen. |
35+
36+
Die vier konkreten Features sind Fensterstart, Dokumentliste, Frage-Panel und das lokale Datenverzeichnis. Schau in `solution/feature_list.json` für die erwartete Evidence pro Feature.

docs/de/projects/project-02-agent-readable-workspace/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@ Füge dem Repository "Lesbarkeit" hinzu, damit ein neuer Agent die Projektstrukt
1111

1212
Du führst es zweimal aus: zuerst ohne Hilfe, dann mit bereits abgelegten `ARCHITECTURE.md`, `PRODUCT.md` und `session-handoff.md`.
1313

14+
## Nutze das eingecheckte Projekt
15+
16+
Repository-Pfad: `projects/project-02/`
17+
18+
| Verzeichnis | Inhalt | Vergleichspunkt |
19+
|------|------|------|
20+
| `starter/` | Code aus Project 01 mit noch unvollständigem Import, Detailansicht und Persistenz. Die Dokumentation ist vorhanden, aber dünner, und `session-handoff.md` fehlt. | Wie viel Kontext eine zweite Agent-Sitzung erneut herausfinden muss. |
21+
| `solution/` | Derselbe Produktschnitt ist fertig, mit Übergabedokumentation unter `projects/project-02/solution/` sowie `feature_list.json` und `session-handoff.md`. | Ob eine neue Sitzung nur aus dem Repository-Zustand weiterarbeiten kann. |
22+
23+
Die Produktfunktionen sind Dokumentimport, vollständiges Laden von Details/Inhalt und Persistenz nach Neustart. Die Harness-Funktion ist ein gut übergebbarer Workspace.
24+
1425
## Werkzeuge
1526

1627
- Claude Code oder Codex

docs/de/projects/project-03-multi-session-continuity/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ Füge dem Agenten Scope-Kontrolle und Verifikationsgates hinzu. Implementiere Do
1111

1212
Du führst es zweimal aus: zuerst ohne Einschränkungen, dann mit strikter Durchsetzung.
1313

14+
## Nutze das eingecheckte Projekt
15+
16+
Repository-Pfad: `projects/project-03/`
17+
18+
| Verzeichnis | Inhalt | Vergleichspunkt |
19+
|------|------|------|
20+
| `starter/` | Project-02-Code, bei dem Indexierung und zitierfähiges Q&A noch unvollständig sind. Es gibt ein erstes `feature_list.json`, aber keine finalen Neustart- und Übergabeartefakte. | Ob der Agent über mehrere Funktionen driftet oder nach einem Neustart Zustand verliert. |
21+
| `solution/` | Chunking, Metadaten, Indexierungsstatus und Q&A mit Zitaten sind fertig, plus `init.sh`, `session-handoff.md`, `claude-progress.md` und `clean-state-checklist.md`. | Ob jede Funktion konkrete Evidenz hat, bevor sie als bestanden markiert wird. |
22+
1423
## Werkzeuge
1524

1625
- Claude Code oder Codex

docs/de/projects/project-04-incremental-indexing/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@ Füge Runtime-Beobachtbarkeit hinzu, etwa Startlogs, Import-/Indexierungslogs un
1111

1212
Du führst es zweimal aus: zuerst ohne Logs oder Regeln, dann mit passenden Werkzeugen und Regeln.
1313

14+
## Nutze das eingecheckte Projekt
15+
16+
Repository-Pfad: `projects/project-04/`
17+
18+
| Verzeichnis | Inhalt | Vergleichspunkt |
19+
|------|------|------|
20+
| `starter/` | Project-03-Code mit schwachen Diagnosesignalen. Der eingebaute Indexierungsfehler kann Chunking bei großen Dateien brechen, und es gibt kein Architekturprüfskript. | Wie lange der Agent ohne Runtime-Signale bis zur Ursache braucht. |
21+
| `solution/` | Strukturierter Logger, Architekturgrenzendokumentation und Prüfsktipt, korrigierte Chunking-Logik und `clean-state-checklist.md`. | Ob Logs und Grenzprüfungen die Korrektur schneller und weniger invasiv machen. |
22+
23+
Wichtige Dateien: `projects/project-04/solution/src/services/logger.ts`, `projects/project-04/solution/scripts/check-architecture.sh`, `projects/project-04/solution/docs/ARCHITECTURE.md`, `projects/project-04/solution/src/services/indexing-service.ts`.
24+
1425
## Werkzeuge
1526

1627
- Claude Code oder Codex

0 commit comments

Comments
 (0)