Allgemeine Einführung
Docs ist eine Open-Source-Plattform für die kollaborative Erstellung von Notizen und die Verwaltung von Dokumenten, die vom suitenumerique-Team entwickelt wurde. Sie nutzt Django und Reagieren Sie Ziel ist es, ein einfach zu bedienendes Tool bereitzustellen, mit dem Nutzer Notizen machen, Dokumente verwalten und Wissen austauschen können. Diese Plattform unterstützt die Zusammenarbeit mehrerer Personen in Echtzeit und eignet sich für den Einsatz im Team. Das Design ist inspiriert von Begriff Docs ist eine neue Version der Software, die völlig kostenlos und quelloffen ist und von den Benutzern selbst eingesetzt werden kann. Sie bietet grundlegende Funktionen für die Bearbeitung von Dokumenten sowie nützliche Funktionen wie Offline-Synchronisation und Dateiexport. docs, das im Kern darauf ausgelegt ist, das Wissensmanagement effizienter zu gestalten, wird weiterhin kontinuierlich aktualisiert und soll im Februar 2025 offiziell veröffentlicht werden.
Funktionsliste
- Gemeinsame Bearbeitung in EchtzeitMehrere Personen können gleichzeitig an einem Dokument arbeiten, wobei die Änderungen in Echtzeit synchronisiert werden.
- Offline-SynchronisationSie können auch ohne Internetverbindung Notizen schreiben, die automatisch synchronisiert werden, wenn Sie mit dem Internet verbunden sind.
- einfaches FormatUnterstützt einfachen Schriftsatz ohne komplexe Markdown-Syntax.
- Dokument-ExportDokumente können in PDF, Word und andere Formate exportiert werden.
- AI-HilfenFunktionen wie Texterstellung, Inhaltszusammenfassung, Übersetzung usw. werden angeboten.
- RechteverwaltungKontrolle darüber, wer Dokumente einsehen oder bearbeiten kann, um die Privatsphäre zu schützen.
- Eingebautes WikiOrganisieren Sie die Notizen des Teams in einer Wissensdatenbank.
- Unterstützung mehrerer SprachenÜbersetzungsunterstützung durch die Crowdin-Plattform für globale Nutzer.
Hilfe verwenden
Docs ist ein Tool, das lokal oder auf einem Server eingesetzt werden muss, und es gibt keine sofort verfügbare Online-Version. Hier finden Sie eine ausführliche Anleitung zur Installation und Verwendung, damit Sie schnell loslegen können.
Einbauverfahren
Für die Ausführung von Docs sind Docker und Docker Compose erforderlich. Stellen Sie also sicher, dass diese auf Ihrem Computer installiert sind. Die offiziell empfohlenen Versionen sind Docker 20.10.2 und Docker Compose 2.32.4. Sie können die Versionen mit den folgenden Befehlen überprüfen:
docker -v
docker compose version
Wenn Sie es nicht installiert haben, können Sie es auf der offiziellen Docker-Website herunterladen und installieren. Fügen Sie nach der Installation Ihren Benutzer zur Docker-Gruppe hinzu, damit Sie nicht mehr eingeben müssen sudo
auf. Die Reihenfolge ist:
sudo usermod -aG docker $USER
Starten Sie dann Ihren Computer neu, damit die Änderungen wirksam werden.
Laden Sie dann den Docs-Code herunter. Öffnen Sie ein Terminal und geben Sie ein:
git clone https://github.com/suitenumerique/docs.git
cd docs
Sobald der Code heruntergeladen ist, gehen Sie zu docs
um mit der Erstellung des Projekts zu beginnen. Führen Sie den folgenden Befehl aus:
docker compose up --build
Dieser Befehl lädt automatisch die Abhängigkeiten herunter, erstellt die Datenbank und startet den Dienst. Möglicherweise müssen Sie einige Minuten auf den ersten Start warten. Wenn Sie im Terminal sehen, dass der Dienst erfolgreich gestartet wurde, ist die Installation abgeschlossen.
Die Dokumente werden standardmäßig unter der lokalen Adresse ausgeführt http://localhost:3000
. Öffnen Sie Ihren Browser und geben Sie diese Adresse ein, um darauf zuzugreifen. Wenn Sie sich mit einem Testkonto anmelden möchten, wird eine offizielle E-Mail-Adresse angegeben test.docs@yopmail.com
und Passwörter I'd<3ToTestDocs
.
Hauptfunktionen
Erstellen und Bearbeiten von Dokumenten
Klicken Sie nach der Anmeldung auf die Schaltfläche "Neues Dokument" auf der Seite, und Docs öffnet eine leere Seite, in die Sie direkt Text eingeben können. Die Bearbeitungsoberfläche ist sehr einfach und unterstützt grundlegende Formatierungen wie fett, kursiv, Titel usw. Bei der Bearbeitung mit mehreren Benutzern sehen Sie die Cursor und Änderungen der anderen Benutzer in Echtzeit. Wenn Sie mit mehreren Benutzern arbeiten, sehen Sie die Cursor und Änderungen der anderen in Echtzeit.
Offline-Synchronisation
Wenn das Netzwerk ausgefallen ist, speichert Docs Ihre Änderungen automatisch lokal. Sobald das Netzwerk wiederhergestellt ist, klicken Sie auf die Schaltfläche "Synchronisieren" in der oberen rechten Ecke und die Änderungen werden auf den Server hochgeladen. Sie brauchen keine zusätzlichen Einstellungen vorzunehmen, das System erledigt das automatisch.
Dokumente exportieren
Wenn Sie mit dem Schreiben Ihres Dokuments fertig sind, klicken Sie auf die Option "Exportieren" in der oberen rechten Ecke. .pdf
und.doc
vielleicht .odt
Format. Nachdem Sie das Format ausgewählt haben, klicken Sie auf "Herunterladen" und die Datei wird auf Ihrem Computer gespeichert.
AI-Hilfen
Docs verfügt über einige integrierte KI-Funktionen, wie z. B. das Generieren oder Übersetzen von Text. Wählen Sie einen Text aus, klicken Sie auf das KI-Symbol in der Symbolleiste und wählen Sie "Generieren" oder "Übersetzen". Wenn Sie z. B. "Schreiben Sie eine Einleitung" eingeben, wird KI den Inhalt automatisch generieren. Wenn Sie übersetzen möchten, wählen Sie die Zielsprache aus, und die KI wird den Text übersetzen. Für diese Funktionen ist eine Internetverbindung erforderlich.
Einrichten von Berechtigungen
Möchten Sie festlegen, wer ein Dokument sehen oder ändern kann? Klicken Sie auf der Dokumentenseite auf die Schaltfläche "Freigeben". In docs können Sie drei Berechtigungen festlegen: schreibgeschützt, bearbeitbar und unsichtbar. Geben Sie die E-Mail-Adresse des Mitarbeiters ein, wählen Sie die Berechtigungen aus und klicken Sie auf "Bestätigen". Sobald die Berechtigungen festgelegt sind, können nur noch eingeladene Personen auf das Dokument zugreifen.
Aufbau eines Wikis
Mit Docs können Sie Ihre Dokumente in Wikis organisieren, indem Sie auf die Option "Wiki" im linken Menü klicken und "Neues Wiki" auswählen. Ziehen Sie vorhandene Dokumente hinein oder schreiben Sie neue Inhalte direkt in das Wiki. Wenn Sie fertig sind, können Teammitglieder die Wissensdatenbank über das Wiki einsehen.
caveat
- Docs verwendet standardmäßig Minio als Speicherdienst. Wenn Sie einen anderen S3-Speicher (z. B. AWS) verwenden möchten, müssen Sie die Konfigurationsdatei ändern. Siehe die offizielle
installation.md
Dokumentation. - Lokale Läufe sind nur für Testzwecke gedacht und können nicht direkt in Produktionsumgebungen eingesetzt werden. Für den Einsatz in der Produktion sind zusätzliche Konfigurationen erforderlich, z. B. die Einrichtung von HTTPS.
Mit diesen Schritten können Sie Docs ganz einfach installieren und verwenden. Docs ist zwar noch in der Entwicklung, erfüllt aber bereits grundlegende Anforderungen an die Verwaltung von Notizen und Dokumenten.
Anwendungsszenario
- Team Projektleitung
Die Teammitglieder verwenden Docs, um den Projektfortschritt festzuhalten und den Aufgabenstatus in Echtzeit zu aktualisieren. Jeder kann die neuesten Inhalte sehen und vermeiden, dass Informationen nicht mehr synchronisiert werden. - Organisation der persönlichen Kenntnisse
Studenten oder Forscher verwenden Docs, um Notizen zu machen und Informationen zu organisieren. Die Exportunterstützung macht es einfach, Notizen in ein Papier oder einen Bericht zu verwandeln. - Telearbeit
Verteilte Teams verwenden Docs zum Verfassen von Dokumenten und zum Festlegen von Berechtigungen, damit nur die zuständigen Personen sensible Inhalte sehen können, und zwar sicher und effizient.
QA
- Sind die Docs kostenlos?
Ja, Docs ist vollständig quelloffen und der Code ist unter der MIT-Lizenz veröffentlicht. Jeder kann es kostenlos herunterladen und verwenden. - Brauche ich Programmierkenntnisse, um es zu benutzen?
Nicht erforderlich. Normale Benutzer können die Grundfunktionen von Docs nutzen, indem sie die Installationsschritte befolgen. Diejenigen, die programmieren können, können den Code ändern, um selbst Funktionen hinzuzufügen. - Unterstützt es Mobiltelefone?
Docs ist derzeit im Web und in mobilen Browsern verfügbar, aber es gibt keine spezielle mobile Anwendung, die in Zukunft entwickelt werden könnte.