olek/AI_template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add foundational documentation templates to support product design and architecture planning, including ADR, archetypes, LLM systems, dev setup, and shared modules.

Browse Source
This commit is contained in:
olekhondera
2025-12-12 02:31:03 +02:00
parent 5053235e95
commit c905cbb725
26 changed files with 759 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/content-structure.md
View File

@@ -13,6 +13,8 @@
Structure of key screens/flows for a generic AI‑assisted product. Use this as a template and adapt to your domain.
> Screen sets depend on the chosen archetype. The sections below illustrate a **pipeline/classification** example; for chat‑first or generation tools, replace with your own flow map (see `/docs/archetypes.md`).
## General Principles
- Web-first (desktop + mobile web); clear, concise copy for target users in your domain.
- Emphasize trust: audit trail, optional reasoning traces, secure webhooks, role-based access, provider-hosted billing.
@@ -31,17 +33,17 @@ Structure of key screens/flows for a generic AI‑assisted product. Use this as
- Connect data sources: OAuth2 to external providers, webhook URL display.
- Confirm webhooks/health; show status and retry guidance.
## 3. Records & Processing
- Records list with filters (date, source, status: ingested, processed, needs_approval, approved, failed).
- Detail drawer: raw fields, matched rule/embedding score, LLM `reasoning_trace`, history, related attachments.
- Bulk actions: reprocess, send to approval, archive (if allowed).
## 3. Items / Artifacts & AI Processing (example)
- Items list with filters (date, source, status).
- Detail view: raw fields, matched rule/embedding score (if used), LLM `reasoning_trace`, history, attachments.
- Bulk actions: reprocess/regenerate, send to review, archive (if allowed).
## 4. Approvals & Rules
- Approval queue: items requiring human review; assign/reassign; batch approve.
- Override outcome with optional rule creation (scope, conditions, action); preview impact/safety notes.
## 4. Human Feedback Loop (optional example)
- Review/approval queue: items requiring human input; assign/reassign; batch actions.
- Override/edit outcome with optional rule creation (scope, conditions, action); preview impact/safety notes.
- Event log snippet (who/what/when, `source_agent`).
## 5. Rules Management
## 5. Rules / Policies Management (optional example)
- Rules list (name, priority, hit rate, last updated, enabled/disabled).
- Rule editor: conditions (source fields, ranges, text, embedding similarity tag), actions (labels/categories/tags), evaluation order.
- Test/preview on a sample set before saving.