菜单
Generate user-facing documentation from Python code (especially PySide6 apps). Triggers on "create user docs", "write documentation for this feature", "generate end-user guide", "create docs for Projekt Kraken", or when pasting code asking for user-facing documentation.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | user-docu |
| description | Generate user-facing documentation from Python code (especially PySide6 apps). Triggers on "create user docs", "write documentation for this feature", "generate end-user guide", "create docs for Projekt Kraken", or when pasting code asking for user-facing documentation. |
| user-invocable | true |
| metadata | {"triggers":["create user docs","write documentation for this feature","generate end-user guide","create docs for Projekt Kraken","user-facing documentation"]} |
Converts Python application code into end-user-focused markdown documentation. Extracts features and explains what users can accomplish, how to use the feature, and common workflows — without exposing technical internals.
The skill extracts features from your code and produces markdown documentation structured for end users:
Each feature gets one .md file with these sections:
A plain-language explanation of what the feature accomplishes. No jargon, no technical terms.
Task-by-task instructions with:
Real, multi-step user tasks showing how features work together.
Helpful hints and common mistakes users encounter.
Think like a worldbuilder: What would a GM or author call this? Examples from ProjektKraken:
Look for distinct user workflows with independent, recognizable tasks
Check docstrings for feature markers (e.g., """Feature: Timeline Display""")
Multiple files often constitute one feature (e.g., map editing spans map_graphicsview.py, raster_layer_item.py, marker_commands.py)
Use lowercase with hyphens: entity-inspector.md, event-timeline.md, relation-graph.md, map-editor.md, calendar-system.md
When documenting ProjektKraken features, use the user's vocabulary:
Avoid technical terms like "repository", "command", "widget", "signal", "database", "serialization". Use plain language instead.
Common User Workflows in ProjektKraken:
Always check if documentation for the feature already exists or overlaps with existing docs. If so, edit the existing file instead of creating a new one. Avoid redundancy across documentation files.
# EntityInspectorWidget
## Core Features
### Entity Editor Panel
The `EntityEditorPanel` widget allows programmatic updates to entity attributes via the `update_entity_details()` method. Supports the `EntityUpdatedSignal` for reactivity.
### Relation Manager
Manages entity-relation connections via `RelationRepository`. Emits `relations_changed_signal` when the relation graph is modified.
### Event Timeline
Displays entity events chronologically. Internally queries `EventRepository` filtered by entity ID.
# Entity Inspector
## What This Does
The Entity Inspector is where you view and edit all the details about a character, location, faction, or other element in your world. You can see everything about an entity in one place, add new details, update existing information, and see what events involve this entity.
## What You Can Do
- View an entity's name, description, and custom attributes
- Edit any detail about an entity at any time
- Add new information and custom fields
- See all events connected to an entity (timeline)
- View relationships to other entities
- Add tags and notes to organize your world
- Attach images and documents to entities
## How to Use It
### View an Entity's Details
1. Click on an entity in the Explorer to select it
2. The Entity Inspector opens on the right side
3. You'll see all the information about that entity
### Edit Entity Information
1. Click on any field in the Inspector (name, description, etc.)
2. Type or paste new information
3. Changes save automatically
### Add Relationships to an Entity
1. In the Entity Inspector, go to the "Relationships" section
2. Click "Add Relationship"
3. Select another entity and the type of relationship (e.g., "is parent of", "rules over")
4. The relationship appears in both entities
## Common Workflows
### Create a New Character
1. Click "New Entity" in the toolbar
2. Type the character's name
3. Click the Inspector to add details (description, role, background)
4. Add relationships to other characters
5. Tag them (e.g., "NPC", "Companion", "Enemy")
### Track a Location's History
1. Open a location entity in the Inspector
2. Look at the "Events" section to see what happened there
3. Add new events by clicking "Create Event" and linking them to this location
## Tips & Gotchas
- Changes save automatically, so don't worry about losing work
- You can create custom fields to track anything unique about your entities (allegiance, power level, magical abilities, etc.)
- Searching will find entities by name or by the text in their descriptions
Before finalizing documentation:
When extracting documentation from ProjektKraken code, know where to look:
UI Widgets (src/gui/widgets/)
Commands (src/commands/)
execute() method shows what the action accomplishesServices (src/services/)
Domain Models (src/core/)
Workflows & Multi-Feature Tasks