Zum Hauptinhalt springen

​
Genow Help Center – Claude Instructions

​
General Rules

  • The Help Center is bilingual: German is the default language and lives at the repo root; English lives under en/ (same relative paths). Every article exists in both languages and must be kept in sync - when you change one language, apply the same change to the other.
  • German articles use the informal du (never “Sie”). Keep Genow proprietary terms and third-party names in English per TRANSLATION-GLOSSARY.md.
  • The API Reference is English only and is never translated.
  • Tone is friendly, direct, and non-technical
  • Explain dependencies and terms briefly in simple language
  • Never be overly verbose – keep sections concise and to the point
  • NEVER touch, edit, or generate any content in the /api-reference/ section

​
Article Structure

Every article follows this structure:
  1. Frontmatter (title, description, optional tag)
  2. Short definition – one sentence explaining what this article covers
  3. Short description of the Frontmatter – brief note on what the header fields mean
  4. Sections separated by horizontal rules (---)
  5. Each section starts with an H2 heading (##)
  6. Subsections use H3 (###)

​
Frontmatter Format

Optional tag for updated articles:

​
Formatting Conventions

​
Dashes

Only use dashes when necessary. When used, always use the short hyphen (-), never the long em dash (—).

​
Horizontal Rules

Use --- before every new H2 section heading to separate content blocks.

​
Highlighting Buttons and UI Elements

Wrap all Genow UI buttons (mostly described with “click on”, “select” etc.) , labels, and interactive elements in Button Name:
  • Click Save to confirm
  • Navigate to Settings → Permissions
Keep navigation instructions consistent with the redesigned navigation:
  • The admin area is opened via Administration in the left-hand sidebar (formerly the “Admin Panel” button in the top-right corner). Use “Administration”, not “Admin Panel”.
  • The interface language, profile settings, usage, Help Center and log out live in the profile menu - the profile card in the bottom-left corner, reachable from any screen (not a top-left or top-right menu).
  • The left sidebar holds: New (start a conversation), Personal Space, Translator, Administration, and your recent/shared chats; external links sit at the bottom.
  • There is no fixed top header; a slim header shows the Agent name and the current chat (or a clickable breadcrumb path in Administration).

​
Callout Components

Use Mintlify callout components to highlight important information. Never overuse them – one per logical block maximum. Example:

​
Steps Component

Use for sequential processes:

​
Frames (Screenshots)

​
Tabs

Use when content differs by user type or configuration method:

​
Section-Specific Guidelines

​
Product / User Guides

Audience: End users – employees using Genow day-to-day.
  • Non-technical language
  • Avoid jargon; if a term must be used, explain it briefly
  • Focus on what the user needs to do, not how it works technically
  • Use Steps components for any process with more than two actions
  • Keep explanations short – users want to find answers quickly
Example tone: Instead of: “The system performs a vector similarity search across indexed knowledge sources” Write: “Genow searches through the connected documents to find the most relevant information”

​
Use Case Management (Agents)

Audience: Use Case Administrators / Domain Experts
  • These are team leads or subject-matter experts managing their own Agent
  • An Agent = a dedicated area for an organisational unit (formerly called “Use Case”)
  • Admins select knowledge, configure settings, sync data, and make it available to their team
  • Semi-technical tone – explain what settings do, but no deep technical background needed
  • Briefly explain dependencies between concepts (e.g. knowledge sources → knowledge assets → agent)
Example tone: Instead of: “Configure the retrieval pipeline parameters” Write: “Choose which documents Genow should search through when your team asks questions”

​
Platform Management

Audience: System Administrators / IT Department
  • Technical tone is appropriate here
  • Cover full setup steps that affect the entire platform
  • Include IDs, configuration values, and exact navigation paths
  • Use Warning callouts for steps that could affect all users
  • Tables are appropriate for permissions, roles, and configuration options

​
Git Workflow

Always follow this workflow for every change session:
  1. Create a new branch from docs before making any changes:
  2. Make all changes on that branch.
  3. At the end of the session, remind the user to push the branch and create a PR — then merge into docs.
Branch naming convention: feature/, fix/, or rename/ prefix followed by a short description (e.g. rename/agent-hub-naming, fix/broken-links).

​
What Claude Must Never Do

  • Never edit, create, or modify any file in /api-reference/
  • Never add an article to mint.json navigation under the api-reference section
  • Never remove existing Mintlify components (Note, Warning, Steps, etc.) without being explicitly asked
  • Never translate the API Reference - it stays English only
  • Never let the German (root) and English (en/) versions of an article drift apart - update both together