Skip to main content

WEP Digital Hub: Content Strategy

Purpose

This document is the single source of truth for contributors of the WEP Digital Hub portal. It defines what content belongs here, how it is organized, and where to find (or link to) content that lives elsewhere.

The goal is to provide a clear, unambiguous direction so that every contributor — human or AI — knows exactly where to place new documentation.


What Belongs in This Repository

The WEP Digital Hub contains technical and architectural documentation for the WEP digital ecosystem. Specifically:

✅ In scope

Content typeExampleSection
System architecture and context mapsEcosystem overview, DDD bounded contexts01-Architecture/
Business processes and proceduresOnboarding, offboarding, service management02-Processes/
Security policies and incident responseIT Policy, AI Policy, access control03-Security/
System documentation (internal apps)Backend WEP, custom tools04-Systems/01-Internal-Apps/
System documentation (third-party SaaS)Zoho, Office365, JustCall, 1Password04-Systems/02-Third-Party-SaaS/
Infrastructure documentationNetwork, hosting, deployment04-Systems/03-Infrastructure/
Governance and meta-documentationADRs, glossary, guidelines, roadmap00-Meta/

❌ Out of scope

Content typeWhere it belongs
End-user documentation (student/parent guides)Dedicated user-facing platform
Marketing contentMarketing team tools
Contracts and legal documentsLegal / document management system
Source codeRespective code repositories
Meeting notes and ephemeral communicationsCollaboration tools (Slack, email)

Note: Out-of-scope content may still be linked from within the portal as external references (e.g., a system page linking to the vendor's user guide, or a process page linking to a legal document). The principle is: host the technical context here, link to the authoritative source elsewhere.


What Gets Linked (Not Duplicated)

Some content lives in external systems and should be linked, not copied. This avoids duplication and ensures the source of truth remains where the content is maintained.

Resource typeExampleHow to link
Architecture diagramsMiro boardsEmbed image + link to live board
Monitoring dashboardsStatus page, uptime toolsLink in 04-Systems/ relevant page
Code repositoriesBackend WEP, Website WEPLink in 04-Systems/01-Internal-Apps/
Vendor documentationZoho API docs, Office365 adminLink in the relevant SaaS page
Module-specific documentationBackend WEP docs, Website WEP docsLink in 04-Systems/01-Internal-Apps/

Future expansion

As individual projects (Backend WEP, Website WEP, etc.) develop their own documentation, their entry in 04-Systems/01-Internal-Apps/ should serve as a landing page with:

  • A brief description of the system
  • Links to the project's own documentation repository or site
  • Key integration points with other WEP systems

Repository Structure

wep-digital-hub/
├── 00-Meta/ # Governance, guidelines, ADRs, glossary
│ ├── 01-Guidelines/ # Operational guides for contributors
│ ├── 02-Templates/ # Document templates
│ ├── 03-Legal/ # Compliance references
│ ├── 04-ADR/ # Architecture Decision Records
│ └── 05-Debates/ # Strategic discussion records
├── 01-Architecture/ # System architecture and design
├── 02-Processes/ # Business processes and SOPs
├── 03-Security/ # Security policies and procedures
├── 04-Systems/ # System-specific documentation
│ ├── 01-Internal-Apps/ # WEP-built applications
│ ├── 02-Third-Party-SaaS/ # External SaaS platforms
│ ├── 03-Infrastructure/ # Network, hosting, servers
│ └── 04-Legacy/ # Deprecated or migrating systems
├── docs-portal/ # Docusaurus configuration (NOT content)
└── .agent/ # Agentic governance (rules, workflows, skills)

Adding a new top-level section

Top-level sections (e.g., 05-NewSection/) should be rare and require an ADR. If you believe new content doesn't fit existing sections, discuss with the Architect first.

When adding a section, you must update:

  1. The include array in docs-portal/docusaurus.config.js
  2. The sidebar config in docs-portal/sidebars.js
  3. This document

Adding content within existing sections

Simply create a .md file (or subdirectory with a README.md) in the appropriate section. Docusaurus auto-generates the sidebar from directory structure.


Conventions (Quick Reference)

These are intentionally brief — follow the links for full details.

RuleReference
Every .md file must have YAML frontmatter (slug, title, last_modified)ADR-001
All content in English; internal docs may use Italian with English summaryADR-004
Use consistent terminology from the glossaryGlossary
Work on feature branches, never directly on mainADR-003

Document Lifecycle (Quick Reference)

PhaseWhat happensReference
CreateWork on a feature branch (docs/, feat/, fix/)Collaboration Workflow
ReviewOpen a PR targeting main, tag reviewersCollaboration Workflow
TrackUpdate ROADMAP.md when completing milestonesROADMAP
ArchiveDeprecated content moves to 04-Legacy/ with a deprecation notice