Documentation Target Groups — Guideline
This page is the strategic classification of the documentation on docs.cockpit-os.de. Each new page belongs to one main target group — not all three at once.
1. Content Creator / Editorial Team (Main Users)
| Who | Editors, local marketing, new staff — career changers, no technical understanding required |
| Goal | To be able to work with the system: content, website (v0), social, approvals — without feeling overwhelmed |
| Navbar | Editorial |
| Entry Point | ★ Start here |
| Language | You, everyday language, explain terms (v0, Outstand, MCP separately) |
| Structure | Top shortcuts & checklists, bottom detailed collapsed |
| Not | API contracts, MEC-CSS checklists, architecture diagrams for investors |
Typical Paths
| Task | Page |
|---|---|
| New to the team | Start here |
| Center website with v0 | Website v0 (Shortcut) → v0 A–Z → Instructions |
| News, Shops, Events | First Steps · Content Management |
| Social | Social (Entry) |
| Approvals | Workflow · Social Approval |
| Search / Index | Topic Finder · Ctrl+K |
Rule for Authors: New editorial features → first shortcut or line on "Start here," then detail page.
2. Management / Decision Makers
| Who | Asset Owners, Center Operators (management), Asset Managers, strategic partners; additionally investors (VC/PE) for platform companies |
| Goal | Understanding: Why the system is built this way, why it is strong, what it can do — build trust in the platform |
| Navbar | Platform |
| Entry Point | Decision Makers & Partners or Platform Overview |
| Terms | No "funders" — in the industry: owners, operators, investors, partners |
| Language | Business & architecture on equal footing, no code examples, no secrets |
| Structure | Arguments, market comparison, maturity evidence, changelog as proof of delivery |
| Not | Copy v0 instructions, dispatch operations, developer gap analyses |
Typical Paths
| Question | Page |
|---|---|
| Platform proof / partnership / due diligence? | Decision Makers & Partners |
| What is CockpitOS conceptually? | Platform Overview |
| Is this “real” software? | Maturity & Operation |
| Due diligence checklist | Due Diligence (Short) |
| What was delivered when? | Change Log |
| Press | Press Release — Texts |
Rule for Authors: Do not invent revenue figures; use product and architecture facts from code/docs.
3. Developers / IT / AI Coding Tools
| Who | Developers, agencies, DevOps, Cursor / Claude / MCP in coding |
| Goal | To extend, integrate, debug the system — architecture, APIs, monorepo, conventions |
| Navbar | Developers |
| Entry Point | ★ Start Development |
| Language | Technically precise, paths in the repo, contracts, env names (without secret values) |
| Structure | Architecture → APIs → Apps/Packages → Special Topics (MEC, WordPress) collapsed |
| Not | “You”-onboarding for v0 (stays under editorial) |
Typical Paths
| Topic | Page / Location |
|---|---|
| Monorepo & Architecture | Start Development |
| Public API / v0 | API Contract |
| AgencyOS / Partner | AgencyOS |
| MCP (Tools, Env) | packages/mcp-cockpit-os · README (Repo) |
| Machine Readable | /ai-integration/cockpit-api-capabilities.json · OpenAPI under /openapi/ |
| Dashboard Navigation (Code) | apps/dashboard/src/config/navigation.ts · Navigation Documentation |
| Schema / DB | packages/database/schema.prisma · db_structure.md (Repo) |
| Cursor Rules (Repo) | .cursor/rules/ |
Note MCP: Server instructions refer, among others, to the Public API Contract. Full context: Start Development.
Rule for Authors: API/architecture change → Developer page + if necessary changelog; editorial only with visible operational changes.
Navbar Overview
| Navbar | Target Group | Do not confuse with |
|---|---|---|
| Editorial | Content Creator | Developer APIs |
| Platform | Management, Investors, Partners | Editorial How-tos |
| Developers | Code, MCP, Cursor | v0 Instructions (→ Editorial) |
| Dashboard, Center Website, Signage, Templates | Cross-section — assign to the appropriate target group depending on the topic |
Team Maintenance
- New page workflow: Documentation Workflow
- Heuristic Code vs. Documentation:
pnpm docs:check(Repo Root) - Internal:
project_specs.md(Milestones, documentation updates)
← Decision Makers & Partners · Start Editorial · Start Development
Nutzungsstatistik: Seitenaufrufe werden anonymisiert erfasst. Im Umami-Dashboard nach diesem Pfad filtern: /en/plattform/doku-zielgruppen