diff --git a/docs/user/spaces/index.md b/docs/user/spaces/index.md index 89430667..15a95463 100644 --- a/docs/user/spaces/index.md +++ b/docs/user/spaces/index.md @@ -34,5 +34,5 @@ Spaces are shared work areas in OpenCloud. They help teams organize content, man - [Customize Spaces](./customize.md) Update descriptions, subtitles, images, and icons for a Space. -- [Best practice](./spaces-best-practices.md) +- [Best practices for organizing Spaces](./spaces-best-practices.md)
Follow recommended structures and naming conventions for Spaces. diff --git a/docs/user/spaces/spaces-best-practices.md b/docs/user/spaces/spaces-best-practices.md index 9522b3e7..030a542e 100644 --- a/docs/user/spaces/spaces-best-practices.md +++ b/docs/user/spaces/spaces-best-practices.md @@ -1,113 +1,299 @@ --- sidebar_position: 90 id: best-practice -title: Best practice -description: Best practice how to use Spaces +title: Best Practices for Organizing Spaces +description: Learn how to organize files and folders in Spaces so that content remains easy to find, understand, and maintain. +draft: false --- -# Best Practices for Organizing Spaces in OpenCloud +# Best Practices for Organizing Spaces -Spaces are collaborative areas meant to be used by multiple users. Unlike personal storage, they must be structured in a way that supports clarity, collaboration, and scalability. This guide helps you set up and maintain well-organized, long-term usable Spaces. +Spaces are collaborative areas designed for content that is shared and maintained by multiple users. -## General Principles +A good structure helps users find content quickly and keeps a Space manageable as the amount of content grows. -- Plan first – Don't treat Spaces like ad-hoc storage. Think ahead. -- Think in roles and teams – Structure based on how people work together. -- Keep it scalable – Choose a structure that works now _and_ with more users later. -- Apply consistency – Naming, access, and structure should follow shared rules. +When organizing a Space, follow two main principles: -## Folder Structure: Recommended Patterns +1. Keep folder structures flat. +2. Use descriptive, self-contained filenames. -### Example: Family +The general rule is: -```plaintext -📁 Family Space - ├── 📂 Documents - │ ├── 🧾 Insurance - │ └── 📑 Contracts - ├── 📂 Photos - │ ├── 📸 2024 - │ └── 📸 2023 - └── 📂 Shared Notes +> Folder structure should provide additional context, but files should not depend on that context to be understood. + +## Keep Folder Structures Flat + +Avoid creating deeply nested folder structures. + +As a general guideline, use no more than three folder levels. Keep the structure even flatter where possible. + +Deep structures can make content harder to navigate and require users to know exactly where a file was stored. + +Avoid structures such as: + +```text +Customers/ +└── Acme/ + └── Contracts/ + └── 2026/ + └── Final/ + └── contract.pdf +``` + +Instead, reduce the number of levels and move important information into the filename: + +```text +Customers/ +└── Acme/ + └── Contracts/ + └── Acme - Service Agreement - 2026.pdf +``` + +This keeps the folder structure easy to navigate while preserving the information required to identify the file. + +Do not create additional folder levels only to represent attributes such as: + +- year +- document status +- document type +- version +- responsible person + +Consider whether this information can be included in the filename instead. + +## Use Descriptive Filenames + +A filename should describe its content without requiring users to know where the file was originally stored. + +Files can appear outside their folder structure when they are: + +- returned in search results +- shown in a recent-files list +- downloaded +- attached to an email +- shared with other users +- moved to another folder or Space + +For example, a filename such as: + +```text +contract.pdf +``` + +provides very little information outside its original folder. + +A more descriptive filename is: + +```text +Acme - Service Agreement - 2026.pdf +``` + +The file can now be identified independently of its location. + +### Include Relevant Context + +Depending on the type of content, useful filename components can include: + +- customer, team, or project name +- document type +- date or year +- reporting period +- topic +- status, if relevant + +For example: + +```text +Acme - Service Agreement - 2026.pdf +Marketing - Campaign Report - 2026-Q2.pdf +Project Atlas - Meeting Notes - 2026-08-11.odt +Class 3B - Parent Information - Summer Trip.pdf +``` + +Only include information that helps users identify the file. Avoid filenames that become unnecessarily long or difficult to scan. + +## Use Consistent Naming Conventions + +Choose a naming convention for a Space and apply it consistently. + +For example: + +```text +[Project] - [Document Type] - [Date] +``` + +could result in: + +```text +Project Atlas - Budget - 2026.xlsx +Project Atlas - Meeting Notes - 2026-08-11.odt +Project Atlas - Status Report - 2026-Q3.pdf +``` + +Consistency makes files easier to recognize and helps users understand how new files should be named. + +When dates are part of a filename, use a consistent format. A format such as `YYYY-MM-DD` also keeps files sorted chronologically: + +```text +2026-08-11 - Meeting Notes.odt +2026-08-18 - Meeting Notes.odt +2026-08-25 - Meeting Notes.odt +``` + +## Organize Content by Purpose + +Folders should represent meaningful areas of work rather than every possible property of a file. + +For example, a team Space could use: + +```text +Marketing/ +├── Campaigns/ +├── Reports/ +├── Templates/ +└── Archive/ +``` + +Files inside these folders should still use descriptive filenames: + +```text +Marketing/ +├── Campaigns/ +│ ├── Product Launch - Campaign Plan - 2026.odt +│ └── Summer Campaign - Results - 2026.pdf +├── Reports/ +│ ├── Marketing - Monthly Report - 2026-07.pdf +│ └── Marketing - Monthly Report - 2026-08.pdf +├── Templates/ +│ └── Marketing - Campaign Brief - Template.odt +└── Archive/ ``` -### School / Kindergarten +This allows the folder structure and filenames to complement each other. + +## Examples + +The appropriate structure depends on how a Space is used. The following examples provide starting points that can be adapted to your organization. -```plaintext +### Company or Team + +```text +Marketing/ +├── Campaigns/ +│ ├── Product Launch - Campaign Plan - 2026.odt +│ └── Summer Campaign - Results - 2026.pdf +├── Reports/ +│ └── Marketing - Quarterly Report - 2026-Q2.pdf +├── Templates/ +│ └── Marketing - Campaign Brief - Template.odt +└── Archive/ +``` -📁 2024 - ├── 📂 Class 3B - │ ├── 📂 Teaching Materials - │ ├── 📂 Parent Communication - │ ├── 📂 Homework Submissions - │ └── 📂 Events & Photos - ├── 📂 Class 4C - │ ├── 📂 Teaching Materials - │ ├── 📂 Parent Communication - │ ├── 📂 Homework Submissions - │ └── 📂 Events & Photos +### Project +```text +Project Atlas/ +├── Planning/ +│ ├── Project Atlas - Project Plan.odt +│ └── Project Atlas - Budget - 2026.xlsx +├── Meetings/ +│ ├── Project Atlas - Meeting Notes - 2026-08-04.odt +│ └── Project Atlas - Meeting Notes - 2026-08-11.odt +└── Deliverables/ + └── Project Atlas - Final Report.pdf ``` -### Company / Team +### School or Kindergarten -```plaintext -📁 Marketing Team - ├── 📂 Campaigns - │ ├── 📂 Q1-2025 - │ └── 📂 Q2-2025 - ├── 📂 Templates - ├── 📂 Reports - └── 📂 Meeting Notes +```text +Class 3B/ +├── Teaching Materials/ +│ └── Class 3B - Mathematics - Fractions.pdf +├── Parent Information/ +│ └── Class 3B - Parent Information - Summer Trip.pdf +└── Events/ + └── Class 3B - Summer Festival - 2026.pdf ``` -## Naming Conventions +### Family + +```text +Family/ +├── Household/ +│ ├── Insurance - Home - 2026.pdf +│ └── Electricity - Contract - Example Energy.pdf +├── Photos/ +│ └── Summer Holiday - 2026/ +└── Archive/ +``` + +The same principles apply in each case: keep the hierarchy understandable and include enough information in filenames for files to remain identifiable outside their folders. + +## Manage Access Separately From Structure -- Use clear, descriptive names – avoid "new folder" or cryptic titles -- Prefer lowercase-with-dashes or Title Case -- Add dates when relevant: `report-2025-Q2.pdf` or `Budget 2024.xlsx` -- Avoid special characters: `& % $ § !` may break integrations +Do not use deeply nested folders only to represent organizational responsibilities or access models. + +Where possible: + +- assign appropriate Space roles +- use groups for recurring sets of users +- grant only the permissions users require +- use a separate Space for sensitive content when a different set of members requires access + +A folder should primarily help users organize and find content. + +## Archive Content Regularly + +Spaces become harder to use when obsolete and current content is mixed together. + +Consider creating an `Archive` folder for content that is no longer actively used but should be retained: + +```text +Project Atlas/ +├── Planning/ +├── Meetings/ +├── Deliverables/ +└── Archive/ +``` -## Ownership & Access Guidelines +Review Spaces regularly and move outdated content to the archive when appropriate. -- Assign Space Owners: Responsible for structure and permissions -- Use Groups where possible for access control (e.g. `staff`, `students`, `parents`) -- Keep sensitive content in separate folders with restricted access -- Define editing vs. viewing rights clearly +Avoid creating archive structures with unnecessary levels. Descriptive filenames should make archived files identifiable even when several years of content are stored together. -## Archiving & Clean-Up +## Common Pitfalls -- Set up an archive folder for old or unused files -- Annually review the Space and remove outdated content -- Use versioning or export before deletion if unsure +| Avoid | Instead | +| --------------------------------------------------- | ------------------------------------------------------- | +| Deep folder hierarchies | Keep structures to approximately three levels | +| Generic filenames such as `document.pdf` | Include enough context in the filename | +| Encoding all information in the folder path | Put important identifying information in filenames | +| Creating folders for every year, status, or version | Add these attributes to filenames when appropriate | +| Different naming styles within the same Space | Define and follow one convention | +| Mixing obsolete and active content | Move inactive content to an archive | +| Using folders as the primary access-control model | Manage access through appropriate roles and permissions | -## Common Pitfalls to Avoid +## Quick Start -| ❌ Don’t | ✅ Instead | -| ------------------------------- | -------------------------------- | -| Dump all files in root folder | Use clear subfolders | -| Mix personal and shared content | Keep personal data in "Personal" | -| Give all users full access | Apply least-privilege principle | -| Use inconsistent naming | Define and follow conventions | +When creating a new Space: -## Shareable Quick Start Template +1. Identify the main areas of work. +2. Create only the folders needed for those areas. +3. Keep the hierarchy as flat as possible. +4. Define a filename convention. +5. Make filenames understandable without their folder path. +6. Define who is responsible for maintaining the Space. +7. Review and archive content regularly. -You can use this as a template for new Spaces: +A simple starting point could be: -```plaintext -📁 [Team/Project Name] - ├── 📂 Documents - ├── 📂 Planning - ├── 📂 Resources - ├── 📂 Archive - └── README.md (Space purpose, structure, rules) +```text +[Space Name]/ +├── Documents/ +├── Planning/ +├── Resources/ +└── Archive/ ``` -## Summary +Adapt the folder names to the purpose of the Space instead of adding additional hierarchy. -| Goal | How | -| ---------------------------- | ---------------------------------- | -| Make Spaces easy to navigate | Use clear folder names & hierarchy | -| Avoid permission chaos | Define ownership and roles | -| Keep things clean | Review regularly and archive | -| Support collaboration | Use group access & standard naming | +The goal is not to create the most detailed folder structure possible. The goal is to make content easy to find, understand, share, and maintain. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/spaces/index.md b/i18n/de/docusaurus-plugin-content-docs/current/user/spaces/index.md index 39c6be1f..256a9c31 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/spaces/index.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/spaces/index.md @@ -35,5 +35,5 @@ Zugriff zu verwalten und Projekt- oder Teamdateien von persönlichen Daten zu tr - [Spaces anpassen](./customize.md) Aktualisieren Sie Beschreibungen, Untertitel, Bilder und Symbole für einen Space. -- [Best Practice](./spaces-best-practices.md) +- [Best Practices für die Organisation von Spaces](./spaces-best-practices.md)
Beachten Sie empfohlene Strukturen und Namenskonventionen für Spaces. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/spaces/spaces-best-practices.md b/i18n/de/docusaurus-plugin-content-docs/current/user/spaces/spaces-best-practices.md index acc0b123..d453d497 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/spaces/spaces-best-practices.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/spaces/spaces-best-practices.md @@ -1,135 +1,299 @@ --- sidebar_position: 90 id: best-practice -title: Best practice -description: Best Practices zur Organisation von Spaces in OpenCloud +title: Best Practices für die Organisation von Spaces +description: Erfahren Sie, wie Sie Dateien und Ordner in Spaces organisieren, damit Inhalte leicht zu finden, verständlich und übersichtlich bleiben. +draft: false --- -# Best Practices zur Organisation von Spaces in OpenCloud - -Spaces sind kollaborative Bereiche, die von mehreren Nutzern verwendet -werden. Anders als persönlicher Speicher müssen sie so aufgebaut sein, -dass sie Klarheit, Zusammenarbeit und Skalierbarkeit unterstützen. -Dieser Leitfaden hilft dir dabei, Spaces gut organisiert und langfristig -nutzbar einzurichten und zu pflegen. - -## Allgemeine Grundsätze - -- Erst planen -- Behandle Spaces nicht wie spontanen Ablagespeicher. - Denke voraus. -- In Rollen und Teams denken -- Strukturiere anhand der Zusammenarbeit - von Personen. -- Skalierbarkeit beachten -- Wähle eine Struktur, die jetzt _und_ - später mit mehr Nutzern funktioniert. -- Konsistenz anwenden -- Benennung, Zugriffsrechte und Aufbau sollten - gemeinsamen Regeln folgen. - -## Ordnerstruktur: Empfohlene Muster - -### Beispiel: Familie - -```plaintext -📁 Familien-Space - ├── 📂 Dokumente - │ ├── 🧾 Versicherungen - │ └── 📑 Verträge - ├── 📂 Fotos - │ ├── 📸 2024 - │ └── 📸 2023 - └── 📂 Gemeinsame Notizen -``` - -### Schule / Kindergarten - -```plaintext -📁 2024 - ├── 📂 Klasse 3B - │ ├── 📂 Unterrichtsmaterial - │ ├── 📂 Elternkommunikation - │ ├── 📂 Hausaufgaben - │ └── 📂 Veranstaltungen & Fotos - ├── 📂 Klasse 4C - │ ├── 📂 Unterrichtsmaterial - │ ├── 📂 Elternkommunikation - │ ├── 📂 Hausaufgaben - │ └── 📂 Veranstaltungen & Fotos -``` - -### Unternehmen / Team - -```plaintext -📁 Marketing-Team - ├── 📂 Kampagnen - │ ├── 📂 Q1-2025 - │ └── 📂 Q2-2025 - ├── 📂 Vorlagen - ├── 📂 Berichte - └── 📂 Meeting-Notizen -``` - -## Namenskonventionen - -- Klare, beschreibende Namen verwenden -- vermeide „Neuer Ordner" oder - kryptische Titel -- Bevorzuge lowercase-mit-bindestrichen oder Title Case -- Relevante Daten hinzufügen: `bericht-2025-Q2.pdf` oder - `Budget 2024.xlsx` -- Sonderzeichen vermeiden: `& % $ § !` können Integrationen stören - -## Richtlinien für Eigentümerschaft & Zugriffe - -- Space Owner festlegen: verantwortlich für Struktur und - Berechtigungen -- Wenn möglich Gruppen für Zugriffskontrolle nutzen (z. B. `staff`, - `students`, `parents`) -- Sensible Inhalte in separate Ordner mit eingeschränktem Zugriff - auslagern -- Bearbeitungs- und Leserechte klar definieren - -## Archivierung & Aufräumen - -- Einen Archiv-Ordner für alte oder ungenutzte Dateien einrichten -- Den Space jährlich überprüfen und veraltete Inhalte entfernen -- Bei Unsicherheit Versionierung nutzen oder vor dem Löschen - exportieren +# Best Practices für die Organisation von Spaces -## Häufige Stolperfallen +Spaces sind kollaborative Bereiche für Inhalte, die von mehreren Personen gemeinsam genutzt und gepflegt werden. + +Eine gute Struktur hilft Nutzern, Inhalte schnell zu finden, und sorgt dafür, dass ein Space auch bei wachsenden Datenmengen übersichtlich bleibt. + +Beachten Sie beim Organisieren eines Spaces zwei wesentliche Grundsätze: + +1. Halten Sie Ordnerstrukturen flach. +2. Verwenden Sie aussagekräftige, eigenständig verständliche Dateinamen. + +Als allgemeine Regel gilt: + +> Die Ordnerstruktur sollte zusätzlichen Kontext liefern. Dateien sollten jedoch auch ohne diesen Kontext verständlich sein. -| ❌ Nicht tun | ✅ Besser so | -| ------------------------------------------ | ------------------------------------------ | -| Alle Dateien im Root-Ordner ablegen | Klare Unterordner verwenden | -| Persönliche und gemeinsame Inhalte mischen | Persönliche Daten in „Persönlich" belassen | -| Allen Nutzern Vollzugriff geben | Least-Privilege-Prinzip anwenden | -| Uneinheitliche Benennungen nutzen | Konventionen definieren & einhalten | +## Ordnerstrukturen flach halten -## Schnellstart-Vorlage zum Teilen +Vermeiden Sie tief verschachtelte Ordnerstrukturen. -Du kannst diese Vorlage für neue Spaces verwenden: +Verwenden Sie als allgemeine Richtlinie höchstens drei Ordnerebenen. Halten Sie die Struktur nach Möglichkeit noch flacher. -```plaintext -📁 [Team-/Projektname] - ├── 📂 Dokumente - ├── 📂 Planung - ├── 📂 Ressourcen - ├── 📂 Archiv - └── README.md (Zweck, Struktur, Regeln des Spaces) +Tiefe Strukturen erschweren die Navigation und setzen voraus, dass Nutzer genau wissen, wo eine Datei gespeichert wurde. + +Vermeiden Sie Strukturen wie diese: + +```text +Kunden/ +└── Acme/ + └── Verträge/ + └── 2026/ + └── Final/ + └── vertrag.pdf ``` -## Zusammenfassung +Reduzieren Sie stattdessen die Anzahl der Ebenen und nehmen Sie wichtige Informationen in den Dateinamen auf: ---- +```text +Kunden/ +└── Acme/ + └── Verträge/ + └── Acme - Dienstleistungsvertrag - 2026.pdf +``` -Ziel Vorgehen +Dadurch bleibt die Ordnerstruktur leicht navigierbar und die zum Identifizieren der Datei erforderlichen Informationen bleiben erhalten. ---- +Erstellen Sie keine zusätzlichen Ordnerebenen, nur um Eigenschaften wie die folgenden abzubilden: -Spaces leicht navigierbar Klare Ordnernamen & Hierarchie nutzen -machen +- Jahr +- Dokumentstatus +- Dokumenttyp +- Version +- verantwortliche Person -Berechtigungschaos vermeiden Eigentümer und Rollen definieren +Prüfen Sie, ob Sie diese Informationen stattdessen in den Dateinamen aufnehmen können. -Ordnung behalten Regelmäßig prüfen und archivieren +## Aussagekräftige Dateinamen verwenden -Zusammenarbeit fördern Gruppenrechte & standardisierte Benennung +Ein Dateiname sollte den Inhalt beschreiben, ohne dass Nutzer den ursprünglichen Speicherort der Datei kennen müssen. ---- +Dateien können außerhalb ihrer Ordnerstruktur erscheinen, wenn sie: + +- in Suchergebnissen ausgegeben werden +- in einer Liste zuletzt verwendeter Dateien angezeigt werden +- heruntergeladen werden +- an eine E-Mail angehängt werden +- mit anderen Nutzern geteilt werden +- in einen anderen Ordner oder Space verschoben werden + +Ein Dateiname wie: + +```text +vertrag.pdf +``` + +liefert außerhalb seines ursprünglichen Ordners nur sehr wenige Informationen. + +Ein aussagekräftigerer Dateiname ist: + +```text +Acme - Dienstleistungsvertrag - 2026.pdf +``` + +Die Datei kann nun unabhängig von ihrem Speicherort identifiziert werden. + +### Relevanten Kontext aufnehmen + +Je nach Art des Inhalts können folgende Bestandteile im Dateinamen hilfreich sein: + +- Kunden-, Team- oder Projektname +- Dokumenttyp +- Datum oder Jahr +- Berichtszeitraum +- Thema +- Status, falls relevant + +Beispiele: + +```text +Acme - Dienstleistungsvertrag - 2026.pdf +Marketing - Kampagnenbericht - 2026-Q2.pdf +Projekt Atlas - Besprechungsnotizen - 2026-08-11.odt +Klasse 3B - Elterninformation - Sommerausflug.pdf +``` + +Nehmen Sie nur Informationen auf, die beim Identifizieren der Datei helfen. Vermeiden Sie unnötig lange oder schwer lesbare Dateinamen. + +## Einheitliche Namenskonventionen verwenden + +Legen Sie eine Namenskonvention für einen Space fest und wenden Sie diese konsequent an. + +Zum Beispiel: + +```text +[Projekt] - [Dokumenttyp] - [Datum] +``` + +Daraus könnten folgende Dateinamen entstehen: + +```text +Projekt Atlas - Budget - 2026.xlsx +Projekt Atlas - Besprechungsnotizen - 2026-08-11.odt +Projekt Atlas - Statusbericht - 2026-Q3.pdf +``` + +Einheitliche Dateinamen sind leichter zu erkennen und zeigen Nutzern, wie sie neue Dateien benennen sollten. + +Wenn ein Dateiname ein Datum enthält, verwenden Sie ein einheitliches Format. Ein Format wie `JJJJ-MM-TT` sorgt außerdem dafür, dass Dateien chronologisch sortiert werden: + +```text +2026-08-11 - Besprechungsnotizen.odt +2026-08-18 - Besprechungsnotizen.odt +2026-08-25 - Besprechungsnotizen.odt +``` + +## Inhalte nach Zweck organisieren + +Ordner sollten sinnvolle Arbeitsbereiche abbilden und nicht jede mögliche Eigenschaft einer Datei. + +Ein Team-Space könnte beispielsweise so aufgebaut sein: + +```text +Marketing/ +├── Kampagnen/ +├── Berichte/ +├── Vorlagen/ +└── Archiv/ +``` + +Die Dateien in diesen Ordnern sollten weiterhin aussagekräftige Namen verwenden: + +```text +Marketing/ +├── Kampagnen/ +│ ├── Produkteinführung - Kampagnenplan - 2026.odt +│ └── Sommerkampagne - Ergebnisse - 2026.pdf +├── Berichte/ +│ ├── Marketing - Monatsbericht - 2026-07.pdf +│ └── Marketing - Monatsbericht - 2026-08.pdf +├── Vorlagen/ +│ └── Marketing - Kampagnenbriefing - Vorlage.odt +└── Archiv/ +``` + +So ergänzen sich Ordnerstruktur und Dateinamen gegenseitig. + +## Beispiele + +Die geeignete Struktur hängt davon ab, wie ein Space genutzt wird. Die folgenden Beispiele dienen als Ausgangspunkt und können an Ihre Organisation angepasst werden. + +### Unternehmen oder Team + +```text +Marketing/ +├── Kampagnen/ +│ ├── Produkteinführung - Kampagnenplan - 2026.odt +│ └── Sommerkampagne - Ergebnisse - 2026.pdf +├── Berichte/ +│ └── Marketing - Quartalsbericht - 2026-Q2.pdf +├── Vorlagen/ +│ └── Marketing - Kampagnenbriefing - Vorlage.odt +└── Archiv/ +``` + +### Projekt + +```text +Projekt Atlas/ +├── Planung/ +│ ├── Projekt Atlas - Projektplan.odt +│ └── Projekt Atlas - Budget - 2026.xlsx +├── Besprechungen/ +│ ├── Projekt Atlas - Besprechungsnotizen - 2026-08-04.odt +│ └── Projekt Atlas - Besprechungsnotizen - 2026-08-11.odt +└── Ergebnisse/ + └── Projekt Atlas - Abschlussbericht.pdf +``` + +### Schule oder Kindergarten + +```text +Klasse 3B/ +├── Unterrichtsmaterialien/ +│ └── Klasse 3B - Mathematik - Bruchrechnung.pdf +├── Elterninformationen/ +│ └── Klasse 3B - Elterninformation - Sommerausflug.pdf +└── Veranstaltungen/ + └── Klasse 3B - Sommerfest - 2026.pdf +``` + +### Familie + +```text +Familie/ +├── Haushalt/ +│ ├── Versicherung - Haus - 2026.pdf +│ └── Strom - Vertrag - Beispiel Energie.pdf +├── Fotos/ +│ └── Sommerurlaub - 2026/ +└── Archiv/ +``` + +In allen Fällen gelten dieselben Grundsätze: Halten Sie die Hierarchie verständlich und nehmen Sie genügend Informationen in Dateinamen auf, damit Dateien auch außerhalb ihrer Ordner identifiziert werden können. + +## Zugriff unabhängig von der Struktur verwalten + +Verwenden Sie keine tief verschachtelten Ordner, nur um organisatorische Zuständigkeiten oder Zugriffsmodelle abzubilden. + +Wenn möglich: + +- weisen Sie geeignete Space-Rollen zu +- verwenden Sie Gruppen für wiederkehrende Nutzerkreise +- gewähren Sie Nutzern nur die erforderlichen Berechtigungen +- verwenden Sie für sensible Inhalte einen separaten Space, wenn ein anderer Personenkreis darauf zugreifen soll + +Ein Ordner sollte in erster Linie dabei helfen, Inhalte zu organisieren und zu finden. + +## Inhalte regelmäßig archivieren + +Spaces werden unübersichtlicher, wenn veraltete und aktuelle Inhalte miteinander vermischt sind. + +Erstellen Sie gegebenenfalls einen Ordner namens `Archiv` für Inhalte, die nicht mehr aktiv verwendet, aber weiterhin aufbewahrt werden sollen: + +```text +Projekt Atlas/ +├── Planung/ +├── Besprechungen/ +├── Ergebnisse/ +└── Archiv/ +``` + +Überprüfen Sie Spaces regelmäßig und verschieben Sie veraltete Inhalte bei Bedarf in das Archiv. + +Vermeiden Sie unnötig verschachtelte Archivstrukturen. Aussagekräftige Dateinamen sorgen dafür, dass archivierte Dateien auch dann identifiziert werden können, wenn Inhalte aus mehreren Jahren gemeinsam gespeichert sind. + +## Häufige Stolperfallen + +| Vermeiden | Stattdessen | +| ------------------------------------------------------- | --------------------------------------------------------------- | +| Tiefe Ordnerhierarchien | Strukturen auf etwa drei Ebenen begrenzen | +| Allgemeine Dateinamen wie `dokument.pdf` | Genügend Kontext in den Dateinamen aufnehmen | +| Alle Informationen im Ordnerpfad abbilden | Wichtige identifizierende Informationen in Dateinamen aufnehmen | +| Ordner für jedes Jahr, jeden Status oder jede Version | Diese Eigenschaften bei Bedarf in Dateinamen aufnehmen | +| Unterschiedliche Benennungsstile innerhalb eines Spaces | Eine Konvention festlegen und einhalten | +| Veraltete und aktuelle Inhalte mischen | Inaktive Inhalte in ein Archiv verschieben | +| Ordner als primäres Modell für die Zugriffskontrolle | Zugriff über geeignete Rollen und Berechtigungen verwalten | + +## Schnellstart + +Wenn Sie einen neuen Space erstellen: + +1. Bestimmen Sie die wichtigsten Arbeitsbereiche. +2. Erstellen Sie nur die für diese Bereiche erforderlichen Ordner. +3. Halten Sie die Hierarchie so flach wie möglich. +4. Legen Sie eine Namenskonvention für Dateien fest. +5. Verwenden Sie Dateinamen, die auch ohne den Ordnerpfad verständlich sind. +6. Legen Sie fest, wer für die Pflege des Spaces verantwortlich ist. +7. Überprüfen und archivieren Sie Inhalte regelmäßig. + +Eine einfache Ausgangsstruktur könnte so aussehen: + +```text +[Space-Name]/ +├── Dokumente/ +├── Planung/ +├── Ressourcen/ +└── Archiv/ +``` + +Passen Sie die Ordnernamen an den Zweck des Spaces an, anstatt zusätzliche Hierarchieebenen hinzuzufügen. + +Das Ziel besteht nicht darin, eine möglichst detaillierte Ordnerstruktur zu erstellen. Inhalte sollen leicht zu finden, zu verstehen, zu teilen und zu pflegen sein. diff --git a/i18n/de/docusaurus-plugin-content-docs/version-7.2/user/spaces/spaces-best-practices.md b/i18n/de/docusaurus-plugin-content-docs/version-7.2/user/spaces/spaces-best-practices.md index acc0b123..d453d497 100644 --- a/i18n/de/docusaurus-plugin-content-docs/version-7.2/user/spaces/spaces-best-practices.md +++ b/i18n/de/docusaurus-plugin-content-docs/version-7.2/user/spaces/spaces-best-practices.md @@ -1,135 +1,299 @@ --- sidebar_position: 90 id: best-practice -title: Best practice -description: Best Practices zur Organisation von Spaces in OpenCloud +title: Best Practices für die Organisation von Spaces +description: Erfahren Sie, wie Sie Dateien und Ordner in Spaces organisieren, damit Inhalte leicht zu finden, verständlich und übersichtlich bleiben. +draft: false --- -# Best Practices zur Organisation von Spaces in OpenCloud - -Spaces sind kollaborative Bereiche, die von mehreren Nutzern verwendet -werden. Anders als persönlicher Speicher müssen sie so aufgebaut sein, -dass sie Klarheit, Zusammenarbeit und Skalierbarkeit unterstützen. -Dieser Leitfaden hilft dir dabei, Spaces gut organisiert und langfristig -nutzbar einzurichten und zu pflegen. - -## Allgemeine Grundsätze - -- Erst planen -- Behandle Spaces nicht wie spontanen Ablagespeicher. - Denke voraus. -- In Rollen und Teams denken -- Strukturiere anhand der Zusammenarbeit - von Personen. -- Skalierbarkeit beachten -- Wähle eine Struktur, die jetzt _und_ - später mit mehr Nutzern funktioniert. -- Konsistenz anwenden -- Benennung, Zugriffsrechte und Aufbau sollten - gemeinsamen Regeln folgen. - -## Ordnerstruktur: Empfohlene Muster - -### Beispiel: Familie - -```plaintext -📁 Familien-Space - ├── 📂 Dokumente - │ ├── 🧾 Versicherungen - │ └── 📑 Verträge - ├── 📂 Fotos - │ ├── 📸 2024 - │ └── 📸 2023 - └── 📂 Gemeinsame Notizen -``` - -### Schule / Kindergarten - -```plaintext -📁 2024 - ├── 📂 Klasse 3B - │ ├── 📂 Unterrichtsmaterial - │ ├── 📂 Elternkommunikation - │ ├── 📂 Hausaufgaben - │ └── 📂 Veranstaltungen & Fotos - ├── 📂 Klasse 4C - │ ├── 📂 Unterrichtsmaterial - │ ├── 📂 Elternkommunikation - │ ├── 📂 Hausaufgaben - │ └── 📂 Veranstaltungen & Fotos -``` - -### Unternehmen / Team - -```plaintext -📁 Marketing-Team - ├── 📂 Kampagnen - │ ├── 📂 Q1-2025 - │ └── 📂 Q2-2025 - ├── 📂 Vorlagen - ├── 📂 Berichte - └── 📂 Meeting-Notizen -``` - -## Namenskonventionen - -- Klare, beschreibende Namen verwenden -- vermeide „Neuer Ordner" oder - kryptische Titel -- Bevorzuge lowercase-mit-bindestrichen oder Title Case -- Relevante Daten hinzufügen: `bericht-2025-Q2.pdf` oder - `Budget 2024.xlsx` -- Sonderzeichen vermeiden: `& % $ § !` können Integrationen stören - -## Richtlinien für Eigentümerschaft & Zugriffe - -- Space Owner festlegen: verantwortlich für Struktur und - Berechtigungen -- Wenn möglich Gruppen für Zugriffskontrolle nutzen (z. B. `staff`, - `students`, `parents`) -- Sensible Inhalte in separate Ordner mit eingeschränktem Zugriff - auslagern -- Bearbeitungs- und Leserechte klar definieren - -## Archivierung & Aufräumen - -- Einen Archiv-Ordner für alte oder ungenutzte Dateien einrichten -- Den Space jährlich überprüfen und veraltete Inhalte entfernen -- Bei Unsicherheit Versionierung nutzen oder vor dem Löschen - exportieren +# Best Practices für die Organisation von Spaces -## Häufige Stolperfallen +Spaces sind kollaborative Bereiche für Inhalte, die von mehreren Personen gemeinsam genutzt und gepflegt werden. + +Eine gute Struktur hilft Nutzern, Inhalte schnell zu finden, und sorgt dafür, dass ein Space auch bei wachsenden Datenmengen übersichtlich bleibt. + +Beachten Sie beim Organisieren eines Spaces zwei wesentliche Grundsätze: + +1. Halten Sie Ordnerstrukturen flach. +2. Verwenden Sie aussagekräftige, eigenständig verständliche Dateinamen. + +Als allgemeine Regel gilt: + +> Die Ordnerstruktur sollte zusätzlichen Kontext liefern. Dateien sollten jedoch auch ohne diesen Kontext verständlich sein. -| ❌ Nicht tun | ✅ Besser so | -| ------------------------------------------ | ------------------------------------------ | -| Alle Dateien im Root-Ordner ablegen | Klare Unterordner verwenden | -| Persönliche und gemeinsame Inhalte mischen | Persönliche Daten in „Persönlich" belassen | -| Allen Nutzern Vollzugriff geben | Least-Privilege-Prinzip anwenden | -| Uneinheitliche Benennungen nutzen | Konventionen definieren & einhalten | +## Ordnerstrukturen flach halten -## Schnellstart-Vorlage zum Teilen +Vermeiden Sie tief verschachtelte Ordnerstrukturen. -Du kannst diese Vorlage für neue Spaces verwenden: +Verwenden Sie als allgemeine Richtlinie höchstens drei Ordnerebenen. Halten Sie die Struktur nach Möglichkeit noch flacher. -```plaintext -📁 [Team-/Projektname] - ├── 📂 Dokumente - ├── 📂 Planung - ├── 📂 Ressourcen - ├── 📂 Archiv - └── README.md (Zweck, Struktur, Regeln des Spaces) +Tiefe Strukturen erschweren die Navigation und setzen voraus, dass Nutzer genau wissen, wo eine Datei gespeichert wurde. + +Vermeiden Sie Strukturen wie diese: + +```text +Kunden/ +└── Acme/ + └── Verträge/ + └── 2026/ + └── Final/ + └── vertrag.pdf ``` -## Zusammenfassung +Reduzieren Sie stattdessen die Anzahl der Ebenen und nehmen Sie wichtige Informationen in den Dateinamen auf: ---- +```text +Kunden/ +└── Acme/ + └── Verträge/ + └── Acme - Dienstleistungsvertrag - 2026.pdf +``` -Ziel Vorgehen +Dadurch bleibt die Ordnerstruktur leicht navigierbar und die zum Identifizieren der Datei erforderlichen Informationen bleiben erhalten. ---- +Erstellen Sie keine zusätzlichen Ordnerebenen, nur um Eigenschaften wie die folgenden abzubilden: -Spaces leicht navigierbar Klare Ordnernamen & Hierarchie nutzen -machen +- Jahr +- Dokumentstatus +- Dokumenttyp +- Version +- verantwortliche Person -Berechtigungschaos vermeiden Eigentümer und Rollen definieren +Prüfen Sie, ob Sie diese Informationen stattdessen in den Dateinamen aufnehmen können. -Ordnung behalten Regelmäßig prüfen und archivieren +## Aussagekräftige Dateinamen verwenden -Zusammenarbeit fördern Gruppenrechte & standardisierte Benennung +Ein Dateiname sollte den Inhalt beschreiben, ohne dass Nutzer den ursprünglichen Speicherort der Datei kennen müssen. ---- +Dateien können außerhalb ihrer Ordnerstruktur erscheinen, wenn sie: + +- in Suchergebnissen ausgegeben werden +- in einer Liste zuletzt verwendeter Dateien angezeigt werden +- heruntergeladen werden +- an eine E-Mail angehängt werden +- mit anderen Nutzern geteilt werden +- in einen anderen Ordner oder Space verschoben werden + +Ein Dateiname wie: + +```text +vertrag.pdf +``` + +liefert außerhalb seines ursprünglichen Ordners nur sehr wenige Informationen. + +Ein aussagekräftigerer Dateiname ist: + +```text +Acme - Dienstleistungsvertrag - 2026.pdf +``` + +Die Datei kann nun unabhängig von ihrem Speicherort identifiziert werden. + +### Relevanten Kontext aufnehmen + +Je nach Art des Inhalts können folgende Bestandteile im Dateinamen hilfreich sein: + +- Kunden-, Team- oder Projektname +- Dokumenttyp +- Datum oder Jahr +- Berichtszeitraum +- Thema +- Status, falls relevant + +Beispiele: + +```text +Acme - Dienstleistungsvertrag - 2026.pdf +Marketing - Kampagnenbericht - 2026-Q2.pdf +Projekt Atlas - Besprechungsnotizen - 2026-08-11.odt +Klasse 3B - Elterninformation - Sommerausflug.pdf +``` + +Nehmen Sie nur Informationen auf, die beim Identifizieren der Datei helfen. Vermeiden Sie unnötig lange oder schwer lesbare Dateinamen. + +## Einheitliche Namenskonventionen verwenden + +Legen Sie eine Namenskonvention für einen Space fest und wenden Sie diese konsequent an. + +Zum Beispiel: + +```text +[Projekt] - [Dokumenttyp] - [Datum] +``` + +Daraus könnten folgende Dateinamen entstehen: + +```text +Projekt Atlas - Budget - 2026.xlsx +Projekt Atlas - Besprechungsnotizen - 2026-08-11.odt +Projekt Atlas - Statusbericht - 2026-Q3.pdf +``` + +Einheitliche Dateinamen sind leichter zu erkennen und zeigen Nutzern, wie sie neue Dateien benennen sollten. + +Wenn ein Dateiname ein Datum enthält, verwenden Sie ein einheitliches Format. Ein Format wie `JJJJ-MM-TT` sorgt außerdem dafür, dass Dateien chronologisch sortiert werden: + +```text +2026-08-11 - Besprechungsnotizen.odt +2026-08-18 - Besprechungsnotizen.odt +2026-08-25 - Besprechungsnotizen.odt +``` + +## Inhalte nach Zweck organisieren + +Ordner sollten sinnvolle Arbeitsbereiche abbilden und nicht jede mögliche Eigenschaft einer Datei. + +Ein Team-Space könnte beispielsweise so aufgebaut sein: + +```text +Marketing/ +├── Kampagnen/ +├── Berichte/ +├── Vorlagen/ +└── Archiv/ +``` + +Die Dateien in diesen Ordnern sollten weiterhin aussagekräftige Namen verwenden: + +```text +Marketing/ +├── Kampagnen/ +│ ├── Produkteinführung - Kampagnenplan - 2026.odt +│ └── Sommerkampagne - Ergebnisse - 2026.pdf +├── Berichte/ +│ ├── Marketing - Monatsbericht - 2026-07.pdf +│ └── Marketing - Monatsbericht - 2026-08.pdf +├── Vorlagen/ +│ └── Marketing - Kampagnenbriefing - Vorlage.odt +└── Archiv/ +``` + +So ergänzen sich Ordnerstruktur und Dateinamen gegenseitig. + +## Beispiele + +Die geeignete Struktur hängt davon ab, wie ein Space genutzt wird. Die folgenden Beispiele dienen als Ausgangspunkt und können an Ihre Organisation angepasst werden. + +### Unternehmen oder Team + +```text +Marketing/ +├── Kampagnen/ +│ ├── Produkteinführung - Kampagnenplan - 2026.odt +│ └── Sommerkampagne - Ergebnisse - 2026.pdf +├── Berichte/ +│ └── Marketing - Quartalsbericht - 2026-Q2.pdf +├── Vorlagen/ +│ └── Marketing - Kampagnenbriefing - Vorlage.odt +└── Archiv/ +``` + +### Projekt + +```text +Projekt Atlas/ +├── Planung/ +│ ├── Projekt Atlas - Projektplan.odt +│ └── Projekt Atlas - Budget - 2026.xlsx +├── Besprechungen/ +│ ├── Projekt Atlas - Besprechungsnotizen - 2026-08-04.odt +│ └── Projekt Atlas - Besprechungsnotizen - 2026-08-11.odt +└── Ergebnisse/ + └── Projekt Atlas - Abschlussbericht.pdf +``` + +### Schule oder Kindergarten + +```text +Klasse 3B/ +├── Unterrichtsmaterialien/ +│ └── Klasse 3B - Mathematik - Bruchrechnung.pdf +├── Elterninformationen/ +│ └── Klasse 3B - Elterninformation - Sommerausflug.pdf +└── Veranstaltungen/ + └── Klasse 3B - Sommerfest - 2026.pdf +``` + +### Familie + +```text +Familie/ +├── Haushalt/ +│ ├── Versicherung - Haus - 2026.pdf +│ └── Strom - Vertrag - Beispiel Energie.pdf +├── Fotos/ +│ └── Sommerurlaub - 2026/ +└── Archiv/ +``` + +In allen Fällen gelten dieselben Grundsätze: Halten Sie die Hierarchie verständlich und nehmen Sie genügend Informationen in Dateinamen auf, damit Dateien auch außerhalb ihrer Ordner identifiziert werden können. + +## Zugriff unabhängig von der Struktur verwalten + +Verwenden Sie keine tief verschachtelten Ordner, nur um organisatorische Zuständigkeiten oder Zugriffsmodelle abzubilden. + +Wenn möglich: + +- weisen Sie geeignete Space-Rollen zu +- verwenden Sie Gruppen für wiederkehrende Nutzerkreise +- gewähren Sie Nutzern nur die erforderlichen Berechtigungen +- verwenden Sie für sensible Inhalte einen separaten Space, wenn ein anderer Personenkreis darauf zugreifen soll + +Ein Ordner sollte in erster Linie dabei helfen, Inhalte zu organisieren und zu finden. + +## Inhalte regelmäßig archivieren + +Spaces werden unübersichtlicher, wenn veraltete und aktuelle Inhalte miteinander vermischt sind. + +Erstellen Sie gegebenenfalls einen Ordner namens `Archiv` für Inhalte, die nicht mehr aktiv verwendet, aber weiterhin aufbewahrt werden sollen: + +```text +Projekt Atlas/ +├── Planung/ +├── Besprechungen/ +├── Ergebnisse/ +└── Archiv/ +``` + +Überprüfen Sie Spaces regelmäßig und verschieben Sie veraltete Inhalte bei Bedarf in das Archiv. + +Vermeiden Sie unnötig verschachtelte Archivstrukturen. Aussagekräftige Dateinamen sorgen dafür, dass archivierte Dateien auch dann identifiziert werden können, wenn Inhalte aus mehreren Jahren gemeinsam gespeichert sind. + +## Häufige Stolperfallen + +| Vermeiden | Stattdessen | +| ------------------------------------------------------- | --------------------------------------------------------------- | +| Tiefe Ordnerhierarchien | Strukturen auf etwa drei Ebenen begrenzen | +| Allgemeine Dateinamen wie `dokument.pdf` | Genügend Kontext in den Dateinamen aufnehmen | +| Alle Informationen im Ordnerpfad abbilden | Wichtige identifizierende Informationen in Dateinamen aufnehmen | +| Ordner für jedes Jahr, jeden Status oder jede Version | Diese Eigenschaften bei Bedarf in Dateinamen aufnehmen | +| Unterschiedliche Benennungsstile innerhalb eines Spaces | Eine Konvention festlegen und einhalten | +| Veraltete und aktuelle Inhalte mischen | Inaktive Inhalte in ein Archiv verschieben | +| Ordner als primäres Modell für die Zugriffskontrolle | Zugriff über geeignete Rollen und Berechtigungen verwalten | + +## Schnellstart + +Wenn Sie einen neuen Space erstellen: + +1. Bestimmen Sie die wichtigsten Arbeitsbereiche. +2. Erstellen Sie nur die für diese Bereiche erforderlichen Ordner. +3. Halten Sie die Hierarchie so flach wie möglich. +4. Legen Sie eine Namenskonvention für Dateien fest. +5. Verwenden Sie Dateinamen, die auch ohne den Ordnerpfad verständlich sind. +6. Legen Sie fest, wer für die Pflege des Spaces verantwortlich ist. +7. Überprüfen und archivieren Sie Inhalte regelmäßig. + +Eine einfache Ausgangsstruktur könnte so aussehen: + +```text +[Space-Name]/ +├── Dokumente/ +├── Planung/ +├── Ressourcen/ +└── Archiv/ +``` + +Passen Sie die Ordnernamen an den Zweck des Spaces an, anstatt zusätzliche Hierarchieebenen hinzuzufügen. + +Das Ziel besteht nicht darin, eine möglichst detaillierte Ordnerstruktur zu erstellen. Inhalte sollen leicht zu finden, zu verstehen, zu teilen und zu pflegen sein. diff --git a/versioned_docs/version-7.2/user/spaces/spaces-best-practices.md b/versioned_docs/version-7.2/user/spaces/spaces-best-practices.md index 9522b3e7..030a542e 100644 --- a/versioned_docs/version-7.2/user/spaces/spaces-best-practices.md +++ b/versioned_docs/version-7.2/user/spaces/spaces-best-practices.md @@ -1,113 +1,299 @@ --- sidebar_position: 90 id: best-practice -title: Best practice -description: Best practice how to use Spaces +title: Best Practices for Organizing Spaces +description: Learn how to organize files and folders in Spaces so that content remains easy to find, understand, and maintain. +draft: false --- -# Best Practices for Organizing Spaces in OpenCloud +# Best Practices for Organizing Spaces -Spaces are collaborative areas meant to be used by multiple users. Unlike personal storage, they must be structured in a way that supports clarity, collaboration, and scalability. This guide helps you set up and maintain well-organized, long-term usable Spaces. +Spaces are collaborative areas designed for content that is shared and maintained by multiple users. -## General Principles +A good structure helps users find content quickly and keeps a Space manageable as the amount of content grows. -- Plan first – Don't treat Spaces like ad-hoc storage. Think ahead. -- Think in roles and teams – Structure based on how people work together. -- Keep it scalable – Choose a structure that works now _and_ with more users later. -- Apply consistency – Naming, access, and structure should follow shared rules. +When organizing a Space, follow two main principles: -## Folder Structure: Recommended Patterns +1. Keep folder structures flat. +2. Use descriptive, self-contained filenames. -### Example: Family +The general rule is: -```plaintext -📁 Family Space - ├── 📂 Documents - │ ├── 🧾 Insurance - │ └── 📑 Contracts - ├── 📂 Photos - │ ├── 📸 2024 - │ └── 📸 2023 - └── 📂 Shared Notes +> Folder structure should provide additional context, but files should not depend on that context to be understood. + +## Keep Folder Structures Flat + +Avoid creating deeply nested folder structures. + +As a general guideline, use no more than three folder levels. Keep the structure even flatter where possible. + +Deep structures can make content harder to navigate and require users to know exactly where a file was stored. + +Avoid structures such as: + +```text +Customers/ +└── Acme/ + └── Contracts/ + └── 2026/ + └── Final/ + └── contract.pdf +``` + +Instead, reduce the number of levels and move important information into the filename: + +```text +Customers/ +└── Acme/ + └── Contracts/ + └── Acme - Service Agreement - 2026.pdf +``` + +This keeps the folder structure easy to navigate while preserving the information required to identify the file. + +Do not create additional folder levels only to represent attributes such as: + +- year +- document status +- document type +- version +- responsible person + +Consider whether this information can be included in the filename instead. + +## Use Descriptive Filenames + +A filename should describe its content without requiring users to know where the file was originally stored. + +Files can appear outside their folder structure when they are: + +- returned in search results +- shown in a recent-files list +- downloaded +- attached to an email +- shared with other users +- moved to another folder or Space + +For example, a filename such as: + +```text +contract.pdf +``` + +provides very little information outside its original folder. + +A more descriptive filename is: + +```text +Acme - Service Agreement - 2026.pdf +``` + +The file can now be identified independently of its location. + +### Include Relevant Context + +Depending on the type of content, useful filename components can include: + +- customer, team, or project name +- document type +- date or year +- reporting period +- topic +- status, if relevant + +For example: + +```text +Acme - Service Agreement - 2026.pdf +Marketing - Campaign Report - 2026-Q2.pdf +Project Atlas - Meeting Notes - 2026-08-11.odt +Class 3B - Parent Information - Summer Trip.pdf +``` + +Only include information that helps users identify the file. Avoid filenames that become unnecessarily long or difficult to scan. + +## Use Consistent Naming Conventions + +Choose a naming convention for a Space and apply it consistently. + +For example: + +```text +[Project] - [Document Type] - [Date] +``` + +could result in: + +```text +Project Atlas - Budget - 2026.xlsx +Project Atlas - Meeting Notes - 2026-08-11.odt +Project Atlas - Status Report - 2026-Q3.pdf +``` + +Consistency makes files easier to recognize and helps users understand how new files should be named. + +When dates are part of a filename, use a consistent format. A format such as `YYYY-MM-DD` also keeps files sorted chronologically: + +```text +2026-08-11 - Meeting Notes.odt +2026-08-18 - Meeting Notes.odt +2026-08-25 - Meeting Notes.odt +``` + +## Organize Content by Purpose + +Folders should represent meaningful areas of work rather than every possible property of a file. + +For example, a team Space could use: + +```text +Marketing/ +├── Campaigns/ +├── Reports/ +├── Templates/ +└── Archive/ +``` + +Files inside these folders should still use descriptive filenames: + +```text +Marketing/ +├── Campaigns/ +│ ├── Product Launch - Campaign Plan - 2026.odt +│ └── Summer Campaign - Results - 2026.pdf +├── Reports/ +│ ├── Marketing - Monthly Report - 2026-07.pdf +│ └── Marketing - Monthly Report - 2026-08.pdf +├── Templates/ +│ └── Marketing - Campaign Brief - Template.odt +└── Archive/ ``` -### School / Kindergarten +This allows the folder structure and filenames to complement each other. + +## Examples + +The appropriate structure depends on how a Space is used. The following examples provide starting points that can be adapted to your organization. -```plaintext +### Company or Team + +```text +Marketing/ +├── Campaigns/ +│ ├── Product Launch - Campaign Plan - 2026.odt +│ └── Summer Campaign - Results - 2026.pdf +├── Reports/ +│ └── Marketing - Quarterly Report - 2026-Q2.pdf +├── Templates/ +│ └── Marketing - Campaign Brief - Template.odt +└── Archive/ +``` -📁 2024 - ├── 📂 Class 3B - │ ├── 📂 Teaching Materials - │ ├── 📂 Parent Communication - │ ├── 📂 Homework Submissions - │ └── 📂 Events & Photos - ├── 📂 Class 4C - │ ├── 📂 Teaching Materials - │ ├── 📂 Parent Communication - │ ├── 📂 Homework Submissions - │ └── 📂 Events & Photos +### Project +```text +Project Atlas/ +├── Planning/ +│ ├── Project Atlas - Project Plan.odt +│ └── Project Atlas - Budget - 2026.xlsx +├── Meetings/ +│ ├── Project Atlas - Meeting Notes - 2026-08-04.odt +│ └── Project Atlas - Meeting Notes - 2026-08-11.odt +└── Deliverables/ + └── Project Atlas - Final Report.pdf ``` -### Company / Team +### School or Kindergarten -```plaintext -📁 Marketing Team - ├── 📂 Campaigns - │ ├── 📂 Q1-2025 - │ └── 📂 Q2-2025 - ├── 📂 Templates - ├── 📂 Reports - └── 📂 Meeting Notes +```text +Class 3B/ +├── Teaching Materials/ +│ └── Class 3B - Mathematics - Fractions.pdf +├── Parent Information/ +│ └── Class 3B - Parent Information - Summer Trip.pdf +└── Events/ + └── Class 3B - Summer Festival - 2026.pdf ``` -## Naming Conventions +### Family + +```text +Family/ +├── Household/ +│ ├── Insurance - Home - 2026.pdf +│ └── Electricity - Contract - Example Energy.pdf +├── Photos/ +│ └── Summer Holiday - 2026/ +└── Archive/ +``` + +The same principles apply in each case: keep the hierarchy understandable and include enough information in filenames for files to remain identifiable outside their folders. + +## Manage Access Separately From Structure -- Use clear, descriptive names – avoid "new folder" or cryptic titles -- Prefer lowercase-with-dashes or Title Case -- Add dates when relevant: `report-2025-Q2.pdf` or `Budget 2024.xlsx` -- Avoid special characters: `& % $ § !` may break integrations +Do not use deeply nested folders only to represent organizational responsibilities or access models. + +Where possible: + +- assign appropriate Space roles +- use groups for recurring sets of users +- grant only the permissions users require +- use a separate Space for sensitive content when a different set of members requires access + +A folder should primarily help users organize and find content. + +## Archive Content Regularly + +Spaces become harder to use when obsolete and current content is mixed together. + +Consider creating an `Archive` folder for content that is no longer actively used but should be retained: + +```text +Project Atlas/ +├── Planning/ +├── Meetings/ +├── Deliverables/ +└── Archive/ +``` -## Ownership & Access Guidelines +Review Spaces regularly and move outdated content to the archive when appropriate. -- Assign Space Owners: Responsible for structure and permissions -- Use Groups where possible for access control (e.g. `staff`, `students`, `parents`) -- Keep sensitive content in separate folders with restricted access -- Define editing vs. viewing rights clearly +Avoid creating archive structures with unnecessary levels. Descriptive filenames should make archived files identifiable even when several years of content are stored together. -## Archiving & Clean-Up +## Common Pitfalls -- Set up an archive folder for old or unused files -- Annually review the Space and remove outdated content -- Use versioning or export before deletion if unsure +| Avoid | Instead | +| --------------------------------------------------- | ------------------------------------------------------- | +| Deep folder hierarchies | Keep structures to approximately three levels | +| Generic filenames such as `document.pdf` | Include enough context in the filename | +| Encoding all information in the folder path | Put important identifying information in filenames | +| Creating folders for every year, status, or version | Add these attributes to filenames when appropriate | +| Different naming styles within the same Space | Define and follow one convention | +| Mixing obsolete and active content | Move inactive content to an archive | +| Using folders as the primary access-control model | Manage access through appropriate roles and permissions | -## Common Pitfalls to Avoid +## Quick Start -| ❌ Don’t | ✅ Instead | -| ------------------------------- | -------------------------------- | -| Dump all files in root folder | Use clear subfolders | -| Mix personal and shared content | Keep personal data in "Personal" | -| Give all users full access | Apply least-privilege principle | -| Use inconsistent naming | Define and follow conventions | +When creating a new Space: -## Shareable Quick Start Template +1. Identify the main areas of work. +2. Create only the folders needed for those areas. +3. Keep the hierarchy as flat as possible. +4. Define a filename convention. +5. Make filenames understandable without their folder path. +6. Define who is responsible for maintaining the Space. +7. Review and archive content regularly. -You can use this as a template for new Spaces: +A simple starting point could be: -```plaintext -📁 [Team/Project Name] - ├── 📂 Documents - ├── 📂 Planning - ├── 📂 Resources - ├── 📂 Archive - └── README.md (Space purpose, structure, rules) +```text +[Space Name]/ +├── Documents/ +├── Planning/ +├── Resources/ +└── Archive/ ``` -## Summary +Adapt the folder names to the purpose of the Space instead of adding additional hierarchy. -| Goal | How | -| ---------------------------- | ---------------------------------- | -| Make Spaces easy to navigate | Use clear folder names & hierarchy | -| Avoid permission chaos | Define ownership and roles | -| Keep things clean | Review regularly and archive | -| Support collaboration | Use group access & standard naming | +The goal is not to create the most detailed folder structure possible. The goal is to make content easy to find, understand, share, and maintain.