Communitygithub.com

samykabu/user-manual

Erstellen, aktualisieren, prüfen und veröffentlichen Sie ein eigenständiges Benutzerhandbuch mit Endbenutzer-, Administrator- und Technik-Ausgaben in Englisch und optional auf Arabisch. Nutzen Sie es ohne Spezifikations-Kit, um ein Handbuch zu beginnen, ein Feature oder Modul zu dokumentieren, die Abdeckung zu prüfen, API-Dokumentation (OpenAPI, AsyncAPI, GraphQL, Webhooks), Versionshinweise und Migrationsleitfäden zu schreiben, UI-Screenshots zu planen und aufzunehmen sowie private Vorschauen und versionierte Veröffentlichungen einzurichten.

Was ist user-manual?

Diese Fähigkeit ermöglicht es einem KI-Agenten, ein vollständiges Benutzerhandbuch aus einer einzigen evidenzbasierten Markdown-Quelle unter `User-Manual/` zu erstellen, zu aktualisieren, zu prüfen und zu veröffentlichen. Sie produziert drei Ausgaben: Endbenutzer, Administrator/Operator und Technische Referenz. Der Fokus liegt auf der Quelle (Markdown), nicht auf dem Rendering; das Rendering ist ein separater, austauschbarer Schritt. Die Fähigkeit unterstützt Workflows für ein neues Handbuch, inkrementelle Aktualisierungen eines bestehenden, Abdeckungsprüfungen, Builds und Aktualitätsprüfungen. Sie erfordert kein `.specify/`, keine Featurespezifikation oder Spezifikations-Kit-Befehle. Der Agent leitet Aufgaben basierend auf der Benutzeranfrage, Repository-Evidenz und Versionskontrolländerungen zu relevanten Referenzdokumenten. Zu den wichtigsten Regeln gehören: Englisch ist erforderlich, Arabisch ist optional; Behauptungen müssen in Implementierung, Verträgen, Tests, beobachtetem Verhalten, Schemata oder genehmigten Infrastrukturquellen begründet sein; niemals Geheimnisse oder ungeschwärzte personenbezogene Daten einfügen; die Markdown-Quelle kanonisch halten, damit sie auf GitHub korrekt gelesen wird; und handverfasste Inhalte außerhalb eigener Markierungen bewahren.

Funktioniert mit~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/samykabu/sanduq-skills/tree/HEAD/skills/dev-tools/skills/user-manual
Original anzeigen→Alle Skills durchsuchen

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

OpenAIChatGPTClaudeClaudeGeminiGeminiGrokGrokPerplexityPerplexityDeepSeekDeepSeek

Dokumentation

Benutzerhandbuch

Eine evidenzbasierte Markdown-Quelle unter User-Manual/ verwalten. Drei Ausgaben veröffentlichen: Endbenutzer, Administrator/Operator und Technische Referenz. Markdown ist das Produkt; Rendering ist ein separater, austauschbarer Schritt.

Wählen Sie den kleinsten Workflow

  • Neues Handbuch: Benutzer interviewen, Repository inspizieren, Modulkarte vorschlagen, Genehmigung einholen, dann scripts/init_manual.py mit einer genehmigten JSON-Moduldatei ausführen.
  • Bestehendes Handbuch: User-Manual/manual.yml lesen, den angeforderten Bereich und den relevanten Git-Diff inspizieren, dann nur die betroffenen Seiten und Assets aktualisieren.
  • Abdeckungsprüfung: scripts/audit_manual.py ausführen und jeden Fehler und jede Warnung erklären.
  • Build: scripts/build_manual.py nur ausführen, nachdem die Prüfung bestanden wurde. Es stellt jede Ausgabe zusammen und rendert sie dann mit renderer.kind in manual.yml: markdown (Standard), command oder mkdocs.
  • Aktualität: scripts/manual_state.py record --feature <dir> nach einem Update ausführen; status beendet sich mit Exit-Code 1, wenn sich die Eingaben oder Handbuchausgaben seit der Aufzeichnung geändert haben.

init_manual.py kopiert die Build-, Prüf- und Status-Skripte (und die mitgelieferten Stylesheets in tools/theme/) nach User-Manual/tools/ für CI. Nach dem Upgrade dieser Fähigkeit diese Kopien aus dem scripts/-Verzeichnis aktualisieren. --no-tools überspringt die Kopien, wenn CI die Skripte von einem anderen Ort ausführt. Die CI-Workflows folgen der ci:-Zuordnung in --ci-policy <file>, ansonsten in .specify/workflow.yml, falls vorhanden.

Diese Fähigkeit erfordert kein .specify/, keine Featurespezifikation oder Spezifikations-Kit-Befehle. Arbeiten Sie basierend auf der Benutzeranfrage, Repository-Evidenz und Versionskontrolländerungen.

Nur das Nötigste routen

AufgabeLesen
Entdeckung und Interviewdiscovery.md
Seitenstruktur und Markdown-Syntaxcontent-model.md
Zielgruppe und Spracheaudience-language.md
Inkrementelle Änderungenincremental-update.md
Entitäten, Spalten, Aufzählungen, ER-Diagrammedata-reference.md
Renderer, Vorlagen, Marke, HTML, PDF, RTLpublishing.md
API-Dokumentationapi-docs.md
Versionshinweise und Migrationsleitfädenrelease-docs.md
UI-Screenshotsui-screenshots.md
Vorschauen und Veröffentlichung von Releasespreview-publishing.md

Unverhandelbare Regeln

  1. Englisch ist erforderlich. Arabisch ist projektabhängig optional, aber Seiten, Renderer, Diagramme und PDFs müssen ab der Initialisierung RTL unterstützen.
  2. Verwenden Sie einfaches, natürliches Englisch oder Arabisch. Schreiben Sie für die angegebene Zielgruppe; verwenden Sie eine technische Erklärung niemals unverändert für einen Endbenutzer wieder.
  3. Begründen Sie Behauptungen in Implementierung, Verträgen, Tests, beobachtetem Verhalten, Schemata oder genehmigten Infrastrukturquellen. Markieren Sie Unbekanntes und erfinden Sie niemals Verhalten.
  4. Fügen Sie niemals Geheimnisse, Anmeldeinformationen, Token, private Schlüssel, Verbindungszeichenfolgen, Produktionsdaten oder ungeschwärzte personenbezogene Daten ein. Verwenden Sie deterministische synthetische Beispiele.
  5. Speichern Sie die genehmigte, erweiterbare Modulkarte in User-Manual/manual.yml. Fügen Sie spätere Entdeckungen bis zur Genehmigung als proposed hinzu.
  6. Halten Sie Markdown kanonisch und schreiben Sie die eigene Syntax von GitHub, sodass jede Seite auf GitHub korrekt gelesen wird; der Build übersetzt sie für andere Renderer. Generieren Sie andere Formate nur über den Build.
  7. Generieren Sie nur nützliche Diagramme mit der illustrate-Fähigkeit, sofern installiert. Halten Sie Systemübersichten getrennt von lesbaren modulbezogenen Details: eine ER-Systemübersicht plus kleinere ER-Moduldiagramme. Dokumentieren Sie jede nachgewiesene Entität, Spalte, jeden Datentyp, jede Beziehung, jede Einschränkung und jede Aufzählung.
  8. Bewahren Sie handverfasste Inhalte außerhalb eigener Markierungen und sorgen Sie dafür, dass Wiederholungen konvergieren.
  9. Verlinken Sie eine Seite nur mit Seiten, die ihre Zielgruppe erhält. Der Build lehnt Seitenlinks zwischen Zielgruppen und fehlende Assets ab und stuft nur die Assets ein, die die Seiten einer Ausgabe erreichen, sodass eine Zielgruppe niemals Screenshots oder Beispiele einer anderen ausliefert.

Beispiel aus der Praxis

Zum Beispiel „Erstellen Sie ein Handbuch für unsere Buchungsplattform“: Identifizieren Sie Buchungs-, Kunden-, Zahlungs- und Betriebsmodule aus Routen, Navigation, APIs, Tests und Schema-Dateien. Bitten Sie den Benutzer, diese Module-Karte zu genehmigen. Erstellen Sie dann zielgruppengerechte Tutorials, sichere Screenshots, API- und Datenreferenzen, englische Inhalte und optionale arabische Inhalte unter User-Manual/ und rendern Sie sie so, wie das Projekt es wünscht: Markdown auf GitHub, die Word-Vorlage des Teams über Pandoc oder eine MkDocs-Website mit PDFs.

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

samykabu/delegate-task

Delegate a task to an external agent CLI harness — Claude Code, OpenAI Codex, OpenCode, GitHub Copilot, or Pi — and get back a normalised result with status (successful / failed / abandoned), a summary, what actually changed on disk measured against git, and total input and output token usage.

samykabu/github-wiki-publish

Publish or update pages, reports, diagrams and assets in a GitHub repository Wiki, preserving existing content and verifying the published result. Use for GitHub Wiki publishing or sync requests, rather than GitHub Pages deployment or general documentation generation.

samykabu/illustrate

Draws diagrams, charts, and technical illustrations (44 types) as self-contained HTML with inline SVG, plus optional SVG/PNG/PDF export, in the project's tracked color and font theme. Use this skill whenever the user asks to draw, diagram, visualize, chart, map, sketch, or illustrate something, even without saying 'illustrate': architecture or system design, infrastructure, cloud or deployment topology, data flow, flowcharts, sequence, state machines, ER or database schema, UML class, dependency graphs, org charts, timelines, Gantt, swimlanes, process or workflow maps, user journeys, kanban, story maps, quadrants, Venn, pyramids, fishbone root-cause, Sankey, Wardley maps, bar, line, scatter, heatmap, waterfall, treemap, radar, or polar charts, and exploded or axonometric views. Also use to redraw .drawio, Mermaid (.mmd), or .excalidraw files, add a diagram to docs, a PR, or a spec, set up the illustration theme, or export a diagram. Not for photos or AI-generated raster images.

samykabu/progress-report

Keep a live, deterministic progress report for a Markdown plan checklist or a Spec Kit feature. Collects task state from the plan file, hook events from Claude Code or Codex, and lane, blocker and decision facts you record, then renders a browser view and a Markdown export with no agent spent on upkeep.

Verwandte Skills

steipete/sag

ElevenLabs text-to-speech with mac-style say UX.

community

steipete/oracle

Oracle CLI second-model review/debug/refactor/design with selected files, dry-run token checks, API or browser engine.

community

steipete/peekaboo

Capture and automate macOS UI with the Peekaboo CLI.

community

mattpocock/design-an-interface

Generate multiple radically different interface designs for a module using parallel sub-agents. Use when user wants to design an API, explore interface options, compare module shapes, or mentions "design it twice".

community

mattpocock/prototype

Build a throwaway prototype to flesh out a design — a runnable terminal app for state/business-logic questions, or several radically different UI variations toggleable from one route.

community

mattpocock/grill-me

Interview the user relentlessly about a plan or design until reaching shared understanding, resolving each branch of the decision tree. Use when user wants to stress-test a plan, get grilled on their design, or mentions "grill me".

community