القائمة
Use when a new service, repository, or subsystem needs documentation — CLAUDE.md for new directories, dartdoc for public APIs, or updating existing architecture docs after a structural change.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | doc-helper |
| description | Use when a new service, repository, or subsystem needs documentation — CLAUDE.md for new directories, dartdoc for public APIs, or updating existing architecture docs after a structural change. |
| allowed-tools | Read, Grep, Glob, Bash, Edit, Write |
| model | sonnet |
Generates accurate, concise documentation grounded in the actual code. Read the code first, then write. Never fabricate API details.
| Request | What to produce |
|---|---|
New lib/core/services/<name>/ | CLAUDE.md in that directory |
New lib/views/<feature>/ | No CLAUDE.md needed — covered by lib/views/CLAUDE.md |
| New public service / repository class | Dartdoc on the class and its public methods |
New subsystem added to lib/core/ | Add a section to lib/core/CLAUDE.md |
| PR ready to open | Use pr-prep skill instead |
Always read:
CLAUDE.md — match tone and structureCLAUDE.md — non-negotiable rules to reference where relevantUse for lib/core/services/<name>/CLAUDE.md:
# <Name> Service
## Purpose
One paragraph. What problem does this service solve? What does it own? What does it NOT own?
## Public API
### `<ClassName>`
Constructor params and what each one does (one line each).
Key public methods — name, return type, one-line purpose.
Skip getters that mirror a property name.
## Invariants & Constraints
- Threading model (main thread / background isolate)
- Caching strategy (e.g., SHA-256 signatures for change detection)
- Error contract (throws / returns null / returns Result type)
- Dependencies on other services and why
## What NOT to Put Here
List things that belong elsewhere (e.g., "UI state → ViewModel").
## Common Mistakes
1–3 bullets of easy-to-make mistakes given this service's shape.
Rules:
copyWith, toString/// Orchestrates RAG query flow: rewrite → embed → search → rank → prompt → stream.
///
/// All methods are safe to call from the main isolate. Heavy work (embedding,
/// HTTP) runs asynchronously and does not block the UI thread.
class RagService {
/// Streams LLM response tokens for [query] using top-[topK] context notes.
///
/// Throws [RagException] if embedding or LLM calls fail after retry.
Stream<String> query(String query, {int topK = 5}) { ... }
}
When a new service or subsystem is added:
lib/core/CLAUDE.mdUse when inserting a new i18n key into Trovara's locale files — adds the key to both en.json and km.json under the correct nested path and verifies parity.
Use when incrementing the Trovara app version before a release — updates the semver and build number in pubspec.yaml following the project's versioning convention.
Use when reviewing a Trovara code change — checks correctness, MVVM layering, security, performance, i18n parity, file-size limits, and test coverage like a senior engineer.
Use when a developer needs orientation to the Trovara codebase — new team member, returning after a gap, or asking "how does X work", "where is Y", or "how do I add a new feature".
Use when adding a new screen, modifying existing feature behavior, or wiring new business logic end-to-end in Trovara — creates MVVM scaffold, route, ServiceLocator wiring, and i18n keys.
Use when adding a new persistable data entity to Trovara — scaffolds the ObjectBox model class, repository interface, ObjectBox implementation, and ServiceLocator wiring, then runs codegen.