Skip to main content

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)

WhoEditors, local marketing, new staff — career changers, no technical understanding required
GoalTo be able to work with the system: content, website (v0), social, approvals — without feeling overwhelmed
NavbarEditorial
Entry Point★ Start here
LanguageYou, everyday language, explain terms (v0, Outstand, MCP separately)
StructureTop shortcuts & checklists, bottom detailed collapsed
NotAPI contracts, MEC-CSS checklists, architecture diagrams for investors

Typical Paths

TaskPage
New to the teamStart here
Center website with v0Website v0 (Shortcut)v0 A–ZInstructions
News, Shops, EventsFirst Steps · Content Management
SocialSocial (Entry)
ApprovalsWorkflow · Social Approval
Search / IndexTopic Finder · Ctrl+K

Rule for Authors: New editorial features → first shortcut or line on "Start here," then detail page.


2. Management / Decision Makers

WhoAsset Owners, Center Operators (management), Asset Managers, strategic partners; additionally investors (VC/PE) for platform companies
GoalUnderstanding: Why the system is built this way, why it is strong, what it can do — build trust in the platform
NavbarPlatform
Entry PointDecision Makers & Partners or Platform Overview
TermsNo "funders" — in the industry: owners, operators, investors, partners
LanguageBusiness & architecture on equal footing, no code examples, no secrets
StructureArguments, market comparison, maturity evidence, changelog as proof of delivery
NotCopy v0 instructions, dispatch operations, developer gap analyses

Typical Paths

QuestionPage
Platform proof / partnership / due diligence?Decision Makers & Partners
What is CockpitOS conceptually?Platform Overview
Is this “real” software?Maturity & Operation
Due diligence checklistDue Diligence (Short)
What was delivered when?Change Log
PressPress Release — Texts

Rule for Authors: Do not invent revenue figures; use product and architecture facts from code/docs.


3. Developers / IT / AI Coding Tools

WhoDevelopers, agencies, DevOps, Cursor / Claude / MCP in coding
GoalTo extend, integrate, debug the system — architecture, APIs, monorepo, conventions
NavbarDevelopers
Entry Point★ Start Development
LanguageTechnically precise, paths in the repo, contracts, env names (without secret values)
StructureArchitecture → APIs → Apps/Packages → Special Topics (MEC, WordPress) collapsed
Not“You”-onboarding for v0 (stays under editorial)

Typical Paths

TopicPage / Location
Monorepo & ArchitectureStart Development
Public API / v0API Contract
AgencyOS / PartnerAgencyOS
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 / DBpackages/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.


NavbarTarget GroupDo not confuse with
EditorialContent CreatorDeveloper APIs
PlatformManagement, Investors, PartnersEditorial How-tos
DevelopersCode, MCP, Cursorv0 Instructions (→ Editorial)
Dashboard, Center Website, Signage, TemplatesCross-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