75 lines
3.0 KiB
Markdown
75 lines
3.0 KiB
Markdown
# Product vision
|
|
|
|
## Product
|
|
|
|
**ItWorx Knowledge Hub** is a self-hosted knowledge, documentation and project
|
|
intelligence platform for one owner and trusted collaborators.
|
|
|
|
It replaces the user's current LeafWiki workflow and becomes the durable home for:
|
|
|
|
- school notes and course material;
|
|
- certification notes;
|
|
- technical reference documentation;
|
|
- infrastructure documentation;
|
|
- troubleshooting knowledge;
|
|
- operational runbooks;
|
|
- project dossiers, decisions and progress;
|
|
- imported attachments and supporting files.
|
|
|
|
## Problem
|
|
|
|
The current knowledge is primarily wiki-shaped, while project knowledge is spread across
|
|
repositories, status notes, deployment details and personal memory. A conventional wiki
|
|
can store those texts, but it does not provide enough structure to answer questions such
|
|
as:
|
|
|
|
- What is the current verified state of a project?
|
|
- Why was an architectural decision made?
|
|
- Which runbook was last validated?
|
|
- Which documents refer to an outdated system?
|
|
- What changed since a previous project milestone?
|
|
- Which content came from the legacy LeafWiki import?
|
|
|
|
The new platform must preserve the speed and durability of Markdown while making project
|
|
and operational knowledge explicit, searchable and auditable.
|
|
|
|
## Vision statement
|
|
|
|
> A private, reliable and recoverable knowledge hub that combines a fast technical wiki
|
|
> with structured project intelligence, and that can later serve external tools through
|
|
> a secure API without depending on those tools.
|
|
|
|
## Product principles
|
|
|
|
1. **Knowledge remains useful without AI.**
|
|
2. **Markdown remains portable and readable.**
|
|
3. **Structure is added where it creates real retrieval value.**
|
|
4. **User data is never silently overwritten or discarded.**
|
|
5. **Imports, revisions and backups are reversible and verifiable.**
|
|
6. **Search respects permissions at every layer.**
|
|
7. **The UI optimizes reading, writing and retrieval—not decoration.**
|
|
8. **The first production topology stays operationally simple.**
|
|
9. **External automation uses stable contracts and least privilege.**
|
|
10. **A future MCP server remains an independent service.**
|
|
|
|
## Primary success outcomes
|
|
|
|
- The owner can migrate representative LeafWiki content without source modification or
|
|
lost pages, links and attachments.
|
|
- School and project documentation can be found in seconds.
|
|
- Projects have one reliable current-state view and a traceable history.
|
|
- Accidental edits and deletions can be recovered.
|
|
- A complete backup can be restored into a clean environment.
|
|
- The system runs predictably on Unraid.
|
|
- A separate future MCP service can retrieve compact, permission-filtered context without
|
|
scraping the UI or reading the database directly.
|
|
|
|
## Product identity
|
|
|
|
- Product name: **ItWorx Knowledge Hub**
|
|
- Primary language: Dutch (`nl-BE`)
|
|
- Technical identifiers and API field names: English
|
|
- Suggested hostname: `knowledge.example.com` (replace it with an operator-controlled
|
|
HTTPS hostname when configuring the reverse proxy).
|
|
- Default local host port: `1240`
|