36 lines
2.9 KiB
Markdown
36 lines
2.9 KiB
Markdown
# HUBrobotix.ai — Modul-Developer-Dokumentation (Pflichtbündel)
|
||
|
||
Dieser Ordner ist die **einzige Dokumentensammlung, die an Dritt-Entwickler ausgegeben wird** —
|
||
bewusst getrennt von `docs/core/`, das interne Infrastrukturdetails (Servernamen, IPs,
|
||
Incident-Historie) enthält und **nicht** an Externe geht. Jede Datei hier ist eine sanitierte,
|
||
entwicklerorientierte Ableitung aus einem oder mehreren internen Konzeptdokumenten — die Quelle
|
||
ist jeweils am Kopf jeder Datei vermerkt, damit wir bei internen Änderungen wissen, welche
|
||
externe Datei nachgezogen werden muss.
|
||
|
||
## Pflichtlektüre-Reihenfolge
|
||
|
||
Ein Entwickler, der ein Modul für HUBrobotix.ai bauen will, muss **alle zehn Dateien** in dieser
|
||
Reihenfolge gelesen haben, bevor er ein Paket einreicht (Prüf-Stufe 1 setzt das implizit voraus).
|
||
**Datei 9 (Agent-System-Prompt)** ist zusätzlich zum Lesen auch wörtlich in den eigenen
|
||
Coding-Agenten zu kopieren, bevor mit der eigentlichen Entwicklung begonnen wird.
|
||
|
||
| # | Datei | Inhalt | Quelle (intern) |
|
||
|---|---|---|---|
|
||
| 1 | [00-getting-started.md](00-getting-started.md) | Überblick, erste Schritte, Ablauf in einem Bild | neu |
|
||
| 2 | [01-manifest-schema.md](01-manifest-schema.md) | `manifest.json`-Schema, Pflichtfelder | `docs/core/module-requirements.md` |
|
||
| 3 | [02-core-api-reference.md](02-core-api-reference.md) | `mod/data/*` + Querschnittsdienste, Scopes | `docs/core/core-api-implementation-plan.md` §3a/§9 |
|
||
| 4 | [03-security-rules.md](03-security-rules.md) | Verbindliche Sicherheitsregeln für Module | `docs/core/hubrobotix-manifest.md` Gesetz 1–4, `security-checklist.md` |
|
||
| 5 | [04-ui-design-guidelines.md](04-ui-design-guidelines.md) | Farb-/Komponenten-Vorgaben, verbotene Muster | `docs/core/ui-design-system.md` |
|
||
| 6 | [05-mockup-guideline.md](05-mockup-guideline.md) | Pflicht-Klick-Dummy vor Implementierung | `docs/core/module-mockup-guideline.md` |
|
||
| 7 | [06-submission-review-process.md](06-submission-review-process.md) | 5-stufige Prüf-Pipeline + menschliches Audit | `docs/core/module-submission-review-concept.md` |
|
||
| 8 | [07-sandbox-usage.md](07-sandbox-usage.md) | Sandbox-Nutzung, Zugangskanäle | `docs/core/module-developer-sandbox-concept.md` §2–§9 (**nicht** §10 LIVE-Interna) |
|
||
| 9 | [08-revenue-share.md](08-revenue-share.md) | Vergütungsmodell | `docs/billing/concept.md` §1.4 |
|
||
| 10 | [09-agent-system-prompt.md](09-agent-system-prompt.md) | Copy-fertiger System-Prompt für den eigenen Coding-Agenten — konsolidiert 00–08 + n8n-Fallstricke + Git/Session-Isolation | neu (verdichtet aus 00–08 + interne Lehren) |
|
||
|
||
## Pflege-Regel
|
||
|
||
Bei jeder inhaltlichen Änderung an einem der internen Quelldokumente prüfen, ob die zugehörige
|
||
Datei hier nachgezogen werden muss — dieser Ordner darf nicht stillschweigend veralten, während
|
||
sich die internen Regeln weiterentwickeln. Kein internes Detail (Server-IPs, Incident-Namen,
|
||
Personennamen, interne Tooling-Pfade wie `/opt/...`) darf in diesen Ordner gelangen.
|