Add project-knowledge structure and templates
- Introduced new maps for navigating project knowledge, including "Current Work," "Fidelity Domain," "Fidelity Apps," "Work Items," and "People." - Created base files for daily notes, decisions, people, systems, work items, and workstreams with defined properties and views. - Developed templates for daily notes, decisions, meeting notes, persons, systems, work items, and workstreams to standardize documentation. - Updated scripts and prompts to reflect the new project-knowledge directory structure. - Removed outdated onboarding and start-here documents, consolidating relevant information into the new maps. - Ensured all references in workflows and scripts point to the new project-knowledge paths.
This commit is contained in:
63
README.md
63
README.md
@@ -4,7 +4,7 @@ Reusable AI-native companion workspace with Fidelity configured as the first rea
|
||||
|
||||
This repository is not the product codebase. It is an operational context layer used to keep project state current, capture communication evidence, prepare standups, draft clear stakeholder updates, and generate self-contained prompts for another AI that has access to the implementation codebase.
|
||||
|
||||
The reusable logic lives in `core/`. The clean human/AI memory lives in `vault/`. Fidelity-specific setup lives in the active profile under `profiles/fidelity/`.
|
||||
The reusable logic lives in `core/`. The clean project second brain lives in `project-knowledge/`. Agent operating memory lives in `agent-memory/`. Fidelity-specific setup lives in the active profile under `profiles/fidelity/`.
|
||||
|
||||
---
|
||||
|
||||
@@ -44,14 +44,14 @@ Integrations extract evidence. The agent promotes memory.
|
||||
|
||||
## Reusable Architecture
|
||||
|
||||
### /vault
|
||||
### /project-knowledge
|
||||
|
||||
Canonical Obsidian second brain and AI memory.
|
||||
Canonical Obsidian second brain and transferable project knowledge.
|
||||
|
||||
- `00-start/` -> onboarding, glossary, start-here, and vault usage
|
||||
- `00-start/` -> onboarding, glossary, and start-here
|
||||
- `01-current/` -> current work and active work-item summary
|
||||
- `02-work-items/` -> ticket/task notes with metadata properties
|
||||
- `03-context/` -> systems, workstreams, process, and iOS context
|
||||
- `03-context/` -> systems, workstreams, project-facing process, and iOS context
|
||||
- `04-people/` -> people, roles, and collaboration context
|
||||
- `05-decisions/` -> durable decisions
|
||||
- `06-daily/` -> daily notes
|
||||
@@ -60,12 +60,22 @@ Canonical Obsidian second brain and AI memory.
|
||||
- `09-templates/` -> Obsidian templates
|
||||
- `attachments/` -> vault assets
|
||||
|
||||
### /agent-memory
|
||||
|
||||
Agent operating memory.
|
||||
|
||||
- `behavior/` -> agent learning and self-maintenance rules
|
||||
- `memory/` -> promotion, correction, and context-maintenance rules
|
||||
- `integrations/` -> memory interface, Obsidian adapter, communication sources, and technical verification
|
||||
- `workflows/` -> AI-to-AI prompting and workspace behavior model
|
||||
- `maps/` -> agent-side navigation maps
|
||||
|
||||
### /core
|
||||
|
||||
Project-independent workspace logic.
|
||||
|
||||
- `README.md` -> reusable operating model
|
||||
- `memory/operational-memory.md` -> memory classes, promotion rules, correction rules, self-maintenance rules
|
||||
- `memory/operational-memory.md` -> reusable memory classes, promotion rules, correction rules, self-maintenance rules
|
||||
- `integrations/communication-model.md` -> live communication and historical archive connector contract
|
||||
- `profiles/create-project-profile.md` -> checklist for adapting the workspace to another project
|
||||
|
||||
@@ -98,7 +108,7 @@ Fidelity iOS ecosystem:
|
||||
|
||||
Runtime inbox for communication evidence.
|
||||
|
||||
- `inbox/` -> communication evidence and transient inbox files before promotion into `vault/`
|
||||
- `inbox/` -> communication evidence and transient inbox files before promotion into `project-knowledge/`
|
||||
|
||||
### /prompts
|
||||
|
||||
@@ -126,11 +136,11 @@ Helpers for automation around memory access, context generation, communication d
|
||||
- `scripts/mattermost/` -> live communication connector
|
||||
- `scripts/slack/` -> historical archive importer
|
||||
|
||||
### /vault/.obsidian
|
||||
### /project-knowledge/.obsidian
|
||||
|
||||
Optional Obsidian vault configuration.
|
||||
|
||||
Open `vault/` as the Obsidian vault. Do not open the repository root as the vault.
|
||||
Open `project-knowledge/` as the Obsidian vault. Do not open the repository root as the vault.
|
||||
|
||||
Portable vault configuration can be versioned, while local layout and plugin runtime files are ignored.
|
||||
|
||||
@@ -144,13 +154,13 @@ Obsidian is the current visual interface over canonical memory. The reusable mem
|
||||
|
||||
Read:
|
||||
|
||||
- `vault/00-start/start-here.md`
|
||||
- `vault/01-current/current-work.md`
|
||||
- `vault/01-current/work-items.md`
|
||||
- `vault/03-context/project.md`
|
||||
- `vault/04-people/manager.md`
|
||||
- `vault/04-people/index.md`
|
||||
- latest file under `vault/06-daily/`
|
||||
- `project-knowledge/00-start/start-here.md`
|
||||
- `project-knowledge/01-current/current-work.md`
|
||||
- `project-knowledge/01-current/work-items.md`
|
||||
- `project-knowledge/03-context/project.md`
|
||||
- `project-knowledge/04-people/manager.md`
|
||||
- `project-knowledge/04-people/index.md`
|
||||
- latest file under `project-knowledge/06-daily/`
|
||||
|
||||
### During the day
|
||||
|
||||
@@ -163,7 +173,7 @@ Capture:
|
||||
|
||||
Write updates in:
|
||||
|
||||
- `vault/06-daily/YYYY-MM-DD.md`
|
||||
- `project-knowledge/06-daily/YYYY-MM-DD.md`
|
||||
|
||||
### Before sending a message
|
||||
|
||||
@@ -254,7 +264,7 @@ Recommended setup:
|
||||
1. Use the workspace-local script at `scripts/mattermost/sync.sh`, or override it with `AIW_MATTERMOST_SYNC_CMD`.
|
||||
2. Let OpenCode run with the project plugins enabled.
|
||||
3. The Mattermost inbox plugin will periodically refresh `ai/inbox/mattermost-latest.md`.
|
||||
4. Promote durable facts from the inbox into `vault/06-daily/`, `vault/01-current/`, `vault/02-work-items/`, and `vault/03-context/`.
|
||||
4. Promote durable facts from the inbox into `project-knowledge/06-daily/`, `project-knowledge/01-current/`, `project-knowledge/02-work-items/`, and `project-knowledge/03-context/`.
|
||||
|
||||
Use `/communication-sync` or `/mattermost-sync` when you want to force a refresh manually.
|
||||
|
||||
@@ -270,17 +280,16 @@ The `FIDELITY_*` variables remain supported as Fidelity-profile aliases, but new
|
||||
|
||||
---
|
||||
|
||||
## Obsidian Vault
|
||||
## Project Knowledge Vault
|
||||
|
||||
Open `vault/` as the Obsidian vault. The repository root remains the technical workspace for OpenCode, scripts, profiles, runtime inboxes, and generated evidence.
|
||||
Open `project-knowledge/` as the Obsidian vault. The repository root remains the technical workspace for OpenCode, scripts, profiles, runtime inboxes, and generated evidence.
|
||||
|
||||
Recommended entry point:
|
||||
|
||||
- `vault/00-start/start-here.md`
|
||||
- `vault/00-start/onboarding.md` for new members
|
||||
- `vault/00-start/glossary.md` for terminology
|
||||
- `vault/00-start/obsidian-usage.md` for navigation rules
|
||||
- `vault/07-maps/` for graph hubs
|
||||
- `project-knowledge/00-start/start-here.md`
|
||||
- `project-knowledge/00-start/onboarding.md` for new members
|
||||
- `project-knowledge/00-start/glossary.md` for terminology
|
||||
- `project-knowledge/07-maps/` for graph hubs
|
||||
|
||||
Use Obsidian for:
|
||||
|
||||
@@ -289,7 +298,7 @@ Use Obsidian for:
|
||||
- manual review of work items, people, decisions, and logs
|
||||
- lightweight editing of the same Markdown memory files
|
||||
|
||||
Do not use Obsidian as a second memory database. The source of truth remains the versioned Markdown files in this repository.
|
||||
Do not use Obsidian as a second memory database. The source of truth remains the versioned Markdown files under `project-knowledge/`.
|
||||
|
||||
Runtime/evidence stays outside the vault:
|
||||
|
||||
@@ -325,7 +334,7 @@ Obsidian adapter helpers live under `scripts/obsidian/`:
|
||||
2. Fill in `profiles/<project>/profile.md`.
|
||||
3. Set `AIW_PROJECT_PROFILE=<project>`.
|
||||
4. Configure any communication connector with `AIW_*` variables.
|
||||
5. Create or adapt `vault/` for the project-specific canonical memory.
|
||||
5. Create or adapt `project-knowledge/` for the project-specific canonical memory.
|
||||
6. Use `/workspace-context` to load the core plus active profile.
|
||||
|
||||
See `core/profiles/create-project-profile.md` for the full checklist.
|
||||
|
||||
Reference in New Issue
Block a user