diff --git a/docs/user/spaces/spaces-best-practices.md b/docs/user/spaces/spaces-best-practices.md new file mode 100644 index 00000000..50187ea6 --- /dev/null +++ b/docs/user/spaces/spaces-best-practices.md @@ -0,0 +1,114 @@ +--- +sidebar_position: 8 +id: best-practice +title: Best practice +description: Best practice how to use Spaces +draft: true +--- + +# Best Practices for Organizing Spaces in OpenCloud + +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. + +## General Principles + +- 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. + +## Folder Structure: Recommended Patterns + +### Example: Family + +```plaintext +πŸ“ Family Space + β”œβ”€β”€ πŸ“‚ Documents + β”‚ β”œβ”€β”€ 🧾 Insurance + β”‚ └── πŸ“‘ Contracts + β”œβ”€β”€ πŸ“‚ Photos + β”‚ β”œβ”€β”€ πŸ“Έ 2024 + β”‚ └── πŸ“Έ 2023 + └── πŸ“‚ Shared Notes +``` + +### School / Kindergarten + +```plaintext + +πŸ“ 2024 + β”œβ”€β”€ πŸ“‚ Class 3B + β”‚ β”œβ”€β”€ πŸ“‚ Teaching Materials + β”‚ β”œβ”€β”€ πŸ“‚ Parent Communication + β”‚ β”œβ”€β”€ πŸ“‚ Homework Submissions + β”‚ └── πŸ“‚ Events & Photos + β”œβ”€β”€ πŸ“‚ Class 4C + β”‚ β”œβ”€β”€ πŸ“‚ Teaching Materials + β”‚ β”œβ”€β”€ πŸ“‚ Parent Communication + β”‚ β”œβ”€β”€ πŸ“‚ Homework Submissions + β”‚ └── πŸ“‚ Events & Photos + +``` + +### Company / Team + +```plaintext +πŸ“ Marketing Team + β”œβ”€β”€ πŸ“‚ Campaigns + β”‚ β”œβ”€β”€ πŸ“‚ Q1-2025 + β”‚ └── πŸ“‚ Q2-2025 + β”œβ”€β”€ πŸ“‚ Templates + β”œβ”€β”€ πŸ“‚ Reports + └── πŸ“‚ Meeting Notes +``` + +## Naming Conventions + +- 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 + +## Ownership & Access Guidelines + +- 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 + +## Archiving & Clean-Up + +- 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 + +## Common Pitfalls to Avoid + +| ❌ 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 | + +## Shareable Quick Start Template + +You can use this as a template for new Spaces: + +```plaintext +πŸ“ [Team/Project Name] + β”œβ”€β”€ πŸ“‚ Documents + β”œβ”€β”€ πŸ“‚ Planning + β”œβ”€β”€ πŸ“‚ Resources + β”œβ”€β”€ πŸ“‚ Archive + └── README.md (Space purpose, structure, rules) +``` + +## Summary + +| 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 |