Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 156 additions & 0 deletions README.de.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
# Safe DOCX Suite

[![CI](https://github.com/usejunior/safe-docx/actions/workflows/ci.yml/badge.svg)](https://github.com/usejunior/safe-docx/actions/workflows/ci.yml)
[![codecov](https://img.shields.io/codecov/c/github/usejunior/safe-docx/main)](https://app.codecov.io/gh/usejunior/safe-docx)

[English](./README.md) | [Español](./README.es.md) | [简体中文](./README.zh.md) | [Português (Brasil)](./README.pt-br.md) | [Deutsch](./README.de.md)

> **Übersetzungshinweis:** Die englische Version `README.md` ist die kanonische Quelle der Wahrheit. Diese Übersetzung kann einen kurzen Rückstand haben. Wesentliche Aktualisierungen des englischen READMEs sollten innerhalb von 72 Stunden in diese Datei übernommen werden.

**safe-docx** von [UseJunior](https://usejunior.com) — nutze Programmier-Agenten auch für Papierkram.

Teil der [UseJunior-Entwicklertools](https://usejunior.com/developer-tools/safe-docx).

Safe Docx ist ein Open-Source-TypeScript-Stack für die chirurgische Bearbeitung bestehender Microsoft Word `.docx`-Dateien. Es wurde für Workflows entwickelt, in denen ein Agent Änderungen vorschlägt und ein Mensch weiterhin zuverlässige, formatierungserhaltende Dokumentenbearbeitungen benötigt.

Wenn du Verträge mit KI prüfst, ist der langsamste Schritt oft das Anwenden akzeptierter Empfehlungen in Word. Safe Docx verwandelt das in deterministische Tool-Aufrufe.

## Warum dieses Projekt existiert

KI-Programmier-CLIs sind großartig bei Code und Textdateien, aber schwach bei der Bearbeitung bestehender `.docx`-Dateien. Geschäfts- und Rechts-Workflows laufen immer noch über Word-Dokumente, daher haben wir einen nativen TypeScript-Pfad gebaut für:

- Lesen und Durchsuchen bestehender Dokumente in token-effizienten Formaten
- Chirurgische Bearbeitungen ohne Zerstörung der Formatierung
- Saubere/nachverfolgte Ausgaben und Revisionsextraktions-Artefakte

Mission: Programmier-Agenten auch für Papierkram befähigen. Safe Docx konzentriert sich auf deterministische Bearbeitungen bestehender Word-Dateien, bei denen Formatierung und Review-Semantik die Automatisierung überleben müssen.

## Positionierung

Safe Docx ist optimiert für Agenten-Workflows, die deterministische, lokale Bearbeitungen bestehender `.docx`-Dateien benötigen:

- Typisierte MCP-Tools für Bearbeitung, Vergleich, Revisionsextraktion, Kommentare, Fußnoten und Layout
- Auditierbares Verhalten mit Testbelegen und Nachverfolgbarkeits-Artefakten
- TypeScript-Laufzeitverteilung ohne Python oder LibreOffice für unterstützte Nutzung

Safe Docx ist nicht dazu gedacht, generierungsorientierte `.docx`-Bibliotheken zu ersetzen.

## Hier starten

Für Einrichtung und tägliche Nutzung siehe:

- `packages/docx-mcp/README.md`

Schnellstart:

```bash
npx -y @usejunior/safe-docx
```

## Wofür Safe Docx optimiert ist

- Brownfield-Bearbeitung bestehender `.docx`-Dateien
- Formatierungserhaltende Textersetzung und Absatzeinfügung
- Kommentar- und Fußnoten-Workflows
- Nachverfolgte Ausgaben zur Überprüfung (`download`, `compare_documents`)
- Revisionsextraktion als strukturiertes JSON (`extract_revisions`)

## Wofür Safe Docx nicht optimiert ist

Safe Docx ist kein Toolkit zur Dokumentenerstellung von Grund auf.

Wenn dein Hauptbedarf die Erstellung neuer `.docx`-Dateien aus Vorlagen oder programmatischem Layout ist, verwende Pakete wie [`docx`](https://www.npmjs.com/package/docx).

## Dokumentenfamilien

### Automatisierte Fixture-Abdeckung in diesem Repository

- Common-Paper-Stil gegenseitige NDA-Fixtures
- Bonterms gegenseitiges NDA-Fixture
- Letter-of-Intent-Fixture
- ILPA Limited-Partnership-Agreement-Redline-Fixtures

### Für komplexe juristische und geschäftliche `.docx`-Klassen konzipiert

- NVCA-Finanzierungsformulare
- YC SAFEs
- Angebotsmemoranden
- Bestellformulare und Dienstleistungsvereinbarungen
- Limited-Partnership-Agreements

## Pakete

- `@usejunior/docx-core`: Primitive und Vergleichs-Engine für bestehende `.docx`-Dokumente
- `@usejunior/docx-mcp`: MCP-Server-Implementierung und Tool-Oberfläche
- `@usejunior/safe-docx`: Kanonischer Installationsname für Endbenutzer (`npx -y @usejunior/safe-docx`)
- `@usejunior/safedocx-mcpb`: Privater MCP-Bundle-Wrapper

## Zuverlässigkeit und Vertrauensoberfläche

- Tool-Schemas werden aus `packages/docx-mcp/src/tool_catalog.ts` generiert.
- OpenSpec-Nachverfolgbarkeitsmatrix: `packages/docx-mcp/src/testing/SAFE_DOCX_OPENSPEC_TRACEABILITY.md`
- Annahmenmatrix: `packages/docx-mcp/assumptions.md`
- Konformitätsleitfaden: `docs/safe-docx/sprint-3-conformance.md`

## Häufig gestellte Fragen

### Was ist Safe Docx?

Ein TypeScript-first DOCX-Bearbeitungs-Stack für Programmier-Agenten-Workflows, die deterministische, formatierungserhaltende Bearbeitungen bestehender Word-Dokumente benötigen.

### Wird die Formatierung bei Bearbeitungen beibehalten?

Das ist ein zentrales Designziel. Die Tool-Oberfläche basiert auf chirurgischen Operationen (`replace_text`, `insert_paragraph`, Layout-Steuerung), die Dokumentstruktur und Formatierungssemantik so weit wie möglich erhalten.

### Wird .NET, Python oder LibreOffice im normalen Laufzeitbetrieb benötigt?

Nein. Die unterstützte Laufzeitnutzung ist JavaScript/TypeScript mit `jszip` + `@xmldom/xmldom`.

### Kann man damit Verträge von Grund auf erstellen?

Nicht der Hauptfokus. Für die Erstellung von Grund auf verwende Pakete wie [`docx`](https://www.npmjs.com/package/docx).

### Welche Dokumenttypen wurden in den Repository-Fixtures getestet?

Gegenseitige NDAs (einschließlich Common-Paper/Bonterms-Stil-Fixtures), Letter of Intent und ILPA Limited-Partnership-Agreement-Redline-Fixtures.

### Ist das nur für Anwälte?

Nein. Die gleichen Bearbeitungsprobleme bei bestehenden `.docx`-Dateien treten in HR, Beschaffung, Finanzen, Vertrieb und anderen papierkramintensiven Workflows auf.

### Wo sollte ich als MCP-Benutzer anfangen?

Verwende `@usejunior/safe-docx` über `npx`, dann folge den Einrichtungsbeispielen in `packages/docx-mcp/README.md`.

### Wo kann ich die Tool-Schemas einsehen?

Siehe die generierte Referenz unter `packages/docx-mcp/docs/tool-reference.generated.md`.

## Entwicklung

```bash
npm ci
npm run build
npm run lint --workspaces --if-present
npm run test:run
npm run check:spec-coverage
npm run test:coverage:packages
npm run coverage:packages:check
npm run coverage:matrix
```

## Siehe auch

- [Open Agreements](https://github.com/open-agreements/open-agreements) — Standardmäßige Rechtsvorlagen mit Programmier-Agenten ausfüllen (NDAs, SAFEs, NVCA)
- [UseJunior-Entwicklertools](https://usejunior.com/developer-tools/safe-docx) — Produktseite mit Installationsoptionen und Tool-Katalog

## Datenschutz

Safe Docx läuft vollständig auf deinem lokalen Rechner. Es werden keine Dokumenteninhalte an externe Server gesendet. Siehe unsere [Datenschutzrichtlinie](https://usejunior.com/privacy_policy) für Details.

## Governance

- [Beitragsleitfaden](CONTRIBUTING.md)
- [Verhaltenskodex](CODE_OF_CONDUCT.md)
- [Sicherheitsrichtlinie](SECURITY.md)
- [Änderungsprotokoll](CHANGELOG.md)
156 changes: 156 additions & 0 deletions README.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
# Safe DOCX Suite

[![CI](https://github.com/usejunior/safe-docx/actions/workflows/ci.yml/badge.svg)](https://github.com/usejunior/safe-docx/actions/workflows/ci.yml)
[![codecov](https://img.shields.io/codecov/c/github/usejunior/safe-docx/main)](https://app.codecov.io/gh/usejunior/safe-docx)

[English](./README.md) | [Español](./README.es.md) | [简体中文](./README.zh.md) | [Português (Brasil)](./README.pt-br.md) | [Deutsch](./README.de.md)

> **Nota de traducción:** La versión en inglés `README.md` es la fuente canónica de la verdad. Esta traducción puede tener un breve retraso. Las actualizaciones importantes del README en inglés deben sincronizarse con este archivo en un plazo de 72 horas.

**safe-docx** por [UseJunior](https://usejunior.com) — usa agentes de programación también para el papeleo.

Parte de las [herramientas para desarrolladores de UseJunior](https://usejunior.com/developer-tools/safe-docx).

Safe Docx es un stack de TypeScript de código abierto para la edición quirúrgica de archivos Microsoft Word `.docx` existentes. Está diseñado para flujos de trabajo donde un agente propone cambios y un humano aún necesita ediciones de documentos confiables que preserven el formato.

Si revisas contratos con IA, el paso más lento suele ser aplicar las recomendaciones aceptadas en Word. Safe Docx convierte eso en llamadas de herramientas deterministas.

## Por qué existe este proyecto

Los CLIs de programación con IA son excelentes con código y archivos de texto, pero débiles en la edición de archivos `.docx` existentes. Los flujos de trabajo empresariales y legales aún funcionan con documentos de Word, así que construimos una ruta nativa en TypeScript para:

- leer y buscar documentos existentes en formatos eficientes en tokens
- realizar ediciones quirúrgicas sin destruir el formato
- producir salidas limpias/con control de cambios y artefactos de extracción de revisiones

Misión: permitir que los agentes de programación también hagan papeleo. Safe Docx se enfoca en ediciones deterministas de archivos Word existentes donde el formato y la semántica de revisión deben sobrevivir a la automatización.

## Posicionamiento

Safe Docx está optimizado para flujos de trabajo de agentes que necesitan ediciones deterministas y locales de archivos `.docx` existentes:

- herramientas MCP tipadas para edición, comparación, extracción de revisiones, comentarios, notas al pie y diseño
- comportamiento auditable con evidencia de pruebas y artefactos de trazabilidad
- distribución en tiempo de ejecución TypeScript sin requerir Python o LibreOffice para el uso soportado

Safe Docx no pretende reemplazar bibliotecas de `.docx` orientadas a la generación.

## Comienza aquí

Para configuración y uso diario, ve a:

- `packages/docx-mcp/README.md`

Ejecución rápida:

```bash
npx -y @usejunior/safe-docx
```

## Para qué está optimizado Safe Docx

- Edición brownfield de archivos `.docx` existentes
- Reemplazo de texto e inserción de párrafos que preservan el formato
- Flujos de trabajo de comentarios y notas al pie
- Salidas con control de cambios para revisión (`download`, `compare_documents`)
- Extracción de revisiones como JSON estructurado (`extract_revisions`)

## Para qué no está optimizado Safe Docx

Safe Docx no es un toolkit de generación de documentos desde cero.

Si tu necesidad principal es generar nuevos archivos `.docx` desde plantillas o diseño programático, usa paquetes como [`docx`](https://www.npmjs.com/package/docx).

## Familias de documentos

### Cobertura automatizada de fixtures en este repositorio

- Fixtures de NDA mutuo estilo Common Paper
- Fixture de NDA mutuo Bonterms
- Fixture de Carta de Intención
- Fixtures de redline de acuerdo de sociedad limitada ILPA

### Diseñado para clases complejas de `.docx` legales y empresariales

- Formularios de financiamiento NVCA
- SAFEs de YC
- Memorandos de oferta
- Formularios de pedido y acuerdos de servicios
- Acuerdos de sociedad limitada

## Paquetes

- `@usejunior/docx-core`: primitivas y motor de comparación para documentos `.docx` existentes
- `@usejunior/docx-mcp`: implementación del servidor MCP y superficie de herramientas
- `@usejunior/safe-docx`: nombre canónico de instalación para el usuario final (`npx -y @usejunior/safe-docx`)
- `@usejunior/safedocx-mcpb`: wrapper privado de bundle MCP

## Confiabilidad y superficie de confianza

- Los esquemas de herramientas se generan desde `packages/docx-mcp/src/tool_catalog.ts`.
- Matriz de trazabilidad OpenSpec: `packages/docx-mcp/src/testing/SAFE_DOCX_OPENSPEC_TRACEABILITY.md`
- Matriz de supuestos: `packages/docx-mcp/assumptions.md`
- Guía de conformidad: `docs/safe-docx/sprint-3-conformance.md`

## Preguntas frecuentes

### ¿Qué es Safe Docx?

Un stack de edición DOCX con TypeScript como prioridad para flujos de trabajo de agentes de programación que necesitan ediciones deterministas y que preservan el formato en documentos Word existentes.

### ¿Preserva el formato durante las ediciones?

Ese es un objetivo central de diseño. La superficie de herramientas está construida alrededor de operaciones quirúrgicas (`replace_text`, `insert_paragraph`, controles de diseño) que preservan la estructura del documento y la semántica de formato tanto como sea posible.

### ¿Requiere .NET, Python o LibreOffice en uso normal?

No. El uso soportado en tiempo de ejecución es JavaScript/TypeScript con `jszip` + `@xmldom/xmldom`.

### ¿Puede generar contratos desde cero?

No es el enfoque principal. Para generación desde cero, usa paquetes como [`docx`](https://www.npmjs.com/package/docx).

### ¿Qué tipos de documentos se han probado en los fixtures del repositorio?

NDAs mutuos (incluyendo fixtures estilo Common Paper/Bonterms), Carta de Intención y fixtures de redline de acuerdo de sociedad limitada ILPA.

### ¿Esto es solo para abogados?

No. Los mismos problemas de edición de archivos `.docx` existentes aparecen en recursos humanos, adquisiciones, finanzas, operaciones de ventas y otros flujos de trabajo con mucho papeleo.

### ¿Por dónde debería empezar como usuario de MCP?

Usa `@usejunior/safe-docx` vía `npx`, luego sigue los ejemplos de configuración en `packages/docx-mcp/README.md`.

### ¿Dónde puedo inspeccionar los esquemas de herramientas?

Consulta la referencia generada en `packages/docx-mcp/docs/tool-reference.generated.md`.

## Desarrollo

```bash
npm ci
npm run build
npm run lint --workspaces --if-present
npm run test:run
npm run check:spec-coverage
npm run test:coverage:packages
npm run coverage:packages:check
npm run coverage:matrix
```

## Ver también

- [Open Agreements](https://github.com/open-agreements/open-agreements) — llena plantillas legales estándar con agentes de programación (NDAs, SAFEs, NVCA)
- [Herramientas para desarrolladores UseJunior](https://usejunior.com/developer-tools/safe-docx) — página del producto con opciones de instalación y catálogo de herramientas

## Privacidad

Safe Docx se ejecuta completamente en tu máquina local. No se envía contenido de documentos a servidores externos. Consulta nuestra [Política de Privacidad](https://usejunior.com/privacy_policy) para más detalles.

## Gobernanza

- [Guía de contribución](CONTRIBUTING.md)
- [Código de conducta](CODE_OF_CONDUCT.md)
- [Política de seguridad](SECURITY.md)
- [Registro de cambios](CHANGELOG.md)
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
[![CI](https://github.com/usejunior/safe-docx/actions/workflows/ci.yml/badge.svg)](https://github.com/usejunior/safe-docx/actions/workflows/ci.yml)
[![codecov](https://img.shields.io/codecov/c/github/usejunior/safe-docx/main)](https://app.codecov.io/gh/usejunior/safe-docx)

[English](./README.md) | [Español](./README.es.md) | [简体中文](./README.zh.md) | [Português (Brasil)](./README.pt-br.md) | [Deutsch](./README.de.md)

**safe-docx** by [UseJunior](https://usejunior.com) — use coding agents for paperwork too.

Part of the [UseJunior developer tools](https://usejunior.com/developer-tools/safe-docx).
Expand Down
Loading
Loading