@page "/help" @attribute [Authorize] @inject ILocalizationService Loc @inject NavigationManager Navigation @Loc["page.title.help"] - Author Buddy

@Loc["page.title.help"]

@if (Loc.CurrentLanguage == "en") {

📋 Overview

AuthorBuddy is an AI-assisted writing environment for authors and requirements engineers. It connects to local LLMs (via Ollama or llama.cpp) to help you edit, analyze, and develop your texts.

Key features at a glance: project management with templates, Markdown editor with versioning, AI writing assistant with multiple modes, spell checking, style analysis, fact-checking (RAG), and Wikipedia research.

📁 Managing Projects

Creating a project: Click File → New Project in the sidebar. Choose between the Novel template (for fiction with drafts, facts, characters) or the Technical template (for requirements documents with specifications and use cases).

Opening a project: All your projects are listed under Projects in the sidebar. Click any project to open it in the editor.

Copying a project: Use the context menu on a project to create a full copy including all files and settings.

✍ Editor

The editor is your main workspace for writing Markdown texts.

đŸ€– AI Assistant

The assistant offers multiple specialized modes. Select a mode from the dropdown, enter your text, and click Execute.

Novel modes (always available):
Technical modes (only with Technical template):

Temperature: The temperature slider controls the AI's creativity (0 = precise/factual, 1 = balanced, 2 = chaotic/experimental).

Custom prompts: Click Edit Prompt to modify the system prompt for the current session. Reset restores the default.

Send to editor: Click the button to transfer the assistant's output directly into the editor.

⚙ Settings

In the settings page you can configure your personal preferences:

When a project is loaded, settings apply to that project. Without a project, your personal default settings are used.

❓ FAQ

How do I index my project for RAG search?
Open the editor with your project, then click Index Project. This scans all .md files and creates embeddings for similarity search.
Why can't I see the technical assistant modes?
Technical modes (Requirements Spec, Use Cases, etc.) only appear when you have a project with the Technical template open.
Why are some file categories disabled?
Exposé and Document categories cannot be combined with other categories. Only one file per project can be the Exposé.
How do I set up 2FA?
Go to Settings → Set up 2FA, scan the QR code with an authenticator app, and enter a verification code.
} else {

📋 Übersicht

AuthorBuddy ist eine KI-gestĂŒtzte Schreibumgebung fĂŒr Autoren und Requirements Engineers. Sie verbindet sich mit lokalen LLMs (via Ollama oder llama.cpp) und hilft dir, Texte zu bearbeiten, zu analysieren und weiterzuentwickeln.

Die wichtigsten Funktionen auf einen Blick: Projektverwaltung mit Vorlagen, Markdown-Editor mit Versionierung, KI-Assistent mit mehreren Modi, RechtschreibprĂŒfung, Stilanalyse, Faktenabfrage (RAG) und Wikipedia-Recherche.

📁 Projekte verwalten

Projekt anlegen: Klicke in der Seitenleiste auf Datei → Neues Projekt. WĂ€hle zwischen der Roman-Vorlage (fĂŒr Belletristik mit Drafts, Fakten, Charakteren) oder der Technischen Vorlage (fĂŒr Anforderungsdokumente mit Lastenheft und Use Cases).

Projekt öffnen: Alle Projekte werden unter Projekte in der Seitenleiste aufgelistet. Klicke auf ein Projekt, um es im Editor zu öffnen.

Projekt kopieren: Nutze das KontextmenĂŒ eines Projekts, um eine vollstĂ€ndige Kopie inkl. aller Dateien und Einstellungen zu erstellen.

✍ Editor

Der Editor ist dein zentraler Arbeitsbereich zum Schreiben von Markdown-Texten.

đŸ€– KI-Assistent

Der Assistent bietet verschiedene spezialisierte Modi. WĂ€hle einen Modus aus dem Dropdown, gib deinen Text ein und klicke auf AusfĂŒhren.

Roman-Modi (immer verfĂŒgbar):
Technische Modi (nur bei technischer Vorlage):

Temperatur: Der Temperatur-Regler beeinflusst die KreativitÀt der KI (0 = prÀzise/faktentreu, 1 = ausgewogen, 2 = chaotisch/experimentell).

Prompt bearbeiten: Klicke auf Prompt bearbeiten, um den System-Prompt fĂŒr die aktuelle Session anzupassen. ZurĂŒcksetzen lĂ€dt den Standard-Prompt.

An Editor ĂŒbermitteln: Der Button ĂŒbertrĂ€gt die Ausgabe des Assistenten direkt in den Editor.

⚙ Einstellungen

In den Einstellungen kannst du deine persönlichen PrÀferenzen konfigurieren:

Wenn ein Projekt geladen ist, gelten die Einstellungen fĂŒr dieses Projekt. Ohne Projekt werden deine persönlichen Standard-Einstellungen verwendet.

❓ FAQ

Wie indexiere ich mein Projekt fĂŒr die RAG-Suche?
Öffne den Editor mit deinem Projekt und klicke auf Projekt indexieren. Dabei werden alle .md-Dateien gescannt und Embeddings fĂŒr die Ähnlichkeitssuche erstellt.
Warum sehe ich die technischen Assistenten-Modi nicht?
Die technischen Modi (Lastenheft, Use Cases usw.) erscheinen nur, wenn du ein Projekt mit der Technischen Vorlage geöffnet hast.
Warum sind manche Datei-Kategorien deaktiviert?
Exposé und Dokument können nicht mit anderen Kategorien kombiniert werden. Pro Projekt kann nur eine Datei das Exposé sein.
Wie richte ich 2FA ein?
Gehe zu Einstellungen → 2FA einrichten, scanne den QR-Code mit einer Authenticator-App und gib einen BestĂ€tigungscode ein.
}