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:
51
project-knowledge/00-start/glossary.md
Normal file
51
project-knowledge/00-start/glossary.md
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
type: glossary
|
||||
audience: new-member
|
||||
tags:
|
||||
- onboarding
|
||||
- glossary
|
||||
---
|
||||
|
||||
# Glossary
|
||||
|
||||
Common terms used in the Fidelity project knowledge vault.
|
||||
|
||||
---
|
||||
|
||||
## Workspace Terms
|
||||
|
||||
- `project-knowledge`: this Obsidian vault; transferable Fidelity project knowledge.
|
||||
- `agent-memory`: agent operating rules outside this vault.
|
||||
- `operational memory`: curated file-based memory that helps future sessions reason accurately.
|
||||
- `daily log`: same-day evidence and evolving findings in `project-knowledge/06-daily/`.
|
||||
- `state`: near-term active work and priorities in `project-knowledge/01-current/`.
|
||||
- `work item`: canonical memory for a ticket, story, task, or investigation in `project-knowledge/02-work-items/`.
|
||||
- `stable context`: durable project knowledge under `project-knowledge/03-context/`.
|
||||
- `inbox`: raw or lightly processed communication evidence under `ai/inbox/`.
|
||||
- `promotion`: moving high-confidence evidence into canonical memory.
|
||||
- `memory interface`: project-agnostic scripts under `scripts/memory/` that create, search, query, and validate project knowledge without coupling the workspace to Obsidian.
|
||||
|
||||
---
|
||||
|
||||
## Fidelity Terms
|
||||
|
||||
- `Fid4`: main Fidelity consumer iOS app and key validation environment.
|
||||
- `XFlowSDK`: backend-driven UI engine that renders flows from service-provided configuration.
|
||||
- `XFlowViewMaker`: adapter layer historically involved in integration and release propagation.
|
||||
- `FTFrameworks`: feature modules such as account opening or transfer flows that can mediate XFlow adoption.
|
||||
- `AO`: account opening context; many reports require careful reproduction and scope validation.
|
||||
- `Discourse`: external issue/report source; treat reports as external until confirmed.
|
||||
- `REST migration`: migration away from GraphQL/Apollo toward REST, with REST behind a feature flag unless confirmed otherwise.
|
||||
- `authenticated flow`: behavior reproduced while signed in; often differs from non-authenticated behavior.
|
||||
- `entry point`: the path used to reach a flow, which can affect backend-driven behavior.
|
||||
- `Cogstore`: flow-configuration publishing and version-comparison platform.
|
||||
|
||||
---
|
||||
|
||||
## Communication Terms
|
||||
|
||||
- `external report`: issue reported externally before regression status is confirmed.
|
||||
- `regression`: behavior confirmed to be newly broken relative to a known baseline.
|
||||
- `scope`: the exact affected flow, platform, auth state, environment, and ownership boundary.
|
||||
- `reproducibility`: whether the behavior can be repeated with known steps and context.
|
||||
- `manager-ready`: concise, explicit, natural professional English that can be sent without rewriting.
|
||||
93
project-knowledge/00-start/onboarding.md
Normal file
93
project-knowledge/00-start/onboarding.md
Normal file
@@ -0,0 +1,93 @@
|
||||
---
|
||||
type: onboarding
|
||||
audience: new-member
|
||||
project: fidelity
|
||||
updated: 2026-04-17
|
||||
tags:
|
||||
- onboarding
|
||||
- map
|
||||
---
|
||||
|
||||
# New Member Onboarding
|
||||
|
||||
Use this guide when someone new needs to understand the Fidelity project context quickly.
|
||||
|
||||
This vault is project knowledge, not the product codebase and not the agent implementation manual.
|
||||
|
||||
---
|
||||
|
||||
## First 30 Minutes
|
||||
|
||||
Read these in order:
|
||||
|
||||
1. [Start Here](start-here.md)
|
||||
2. [Current Work Map](../07-maps/current-work.md)
|
||||
3. [Fidelity Domain Map](../07-maps/fidelity-domain.md)
|
||||
4. [Work Items Map](../07-maps/work-items.md)
|
||||
5. [People Map](../07-maps/people.md)
|
||||
|
||||
Goal:
|
||||
|
||||
- understand where current work lives
|
||||
- identify active tickets
|
||||
- understand the main systems and people
|
||||
- avoid treating raw logs or inbox evidence as confirmed durable truth
|
||||
|
||||
---
|
||||
|
||||
## First 60 Minutes
|
||||
|
||||
Read:
|
||||
|
||||
1. [Project Context](../03-context/project.md)
|
||||
2. [XFlowSDK](../03-context/systems/xflowsdk.md)
|
||||
3. [Fid4](../03-context/systems/fid4.md)
|
||||
4. [REST Migration](../03-context/workstreams/rest-migration.md)
|
||||
5. [AO And Discourse](../03-context/workstreams/ao-discourse.md)
|
||||
6. [Communication](../03-context/process/communication.md)
|
||||
|
||||
Goal:
|
||||
|
||||
- understand why auth state, entry point, and backend configuration matter
|
||||
- distinguish external reports from regressions
|
||||
- understand why communication precision is part of the engineering workflow
|
||||
|
||||
---
|
||||
|
||||
## First 120 Minutes
|
||||
|
||||
Read:
|
||||
|
||||
1. [Systems Index](../03-context/systems/index.md)
|
||||
2. [Workstreams Index](../03-context/workstreams/index.md)
|
||||
3. [iOS Context](../03-context/ios/index.md)
|
||||
4. [Jira Story Rules](../03-context/process/jira-story-rules.md)
|
||||
5. [Pull Requests](../03-context/process/pull-requests.md)
|
||||
|
||||
Goal:
|
||||
|
||||
- understand how Fidelity project knowledge is organized
|
||||
- know where to find durable systems, workstreams, people, decisions, and active tickets
|
||||
- know the communication standards expected for standups, Jira, PRs, and manager updates
|
||||
|
||||
---
|
||||
|
||||
## Daily Workflow
|
||||
|
||||
1. Start from [Current Work Map](../07-maps/current-work.md).
|
||||
2. Check [Current Work](../01-current/current-work.md).
|
||||
3. Open the active work item from [Work Items Map](../07-maps/work-items.md).
|
||||
4. Review the latest relevant note from [Daily Notes Index](../06-daily/index.md).
|
||||
5. Use [Communication](../03-context/process/communication.md) before writing standups, Jira comments, or manager updates.
|
||||
|
||||
---
|
||||
|
||||
## Rules Of Thumb
|
||||
|
||||
- `project-knowledge/06-daily/` is dated work evidence.
|
||||
- `project-knowledge/01-current/` is what matters now.
|
||||
- `project-knowledge/02-work-items/` is canonical ticket memory.
|
||||
- `project-knowledge/03-context/` is durable project knowledge.
|
||||
- `project-knowledge/04-people/` is collaborator and role memory.
|
||||
- `project-knowledge/05-decisions/` is durable decision history.
|
||||
- `ai/inbox/` and generated files are raw evidence, not promoted memory.
|
||||
93
project-knowledge/00-start/start-here.md
Normal file
93
project-knowledge/00-start/start-here.md
Normal file
@@ -0,0 +1,93 @@
|
||||
---
|
||||
type: map
|
||||
audience: project-reader
|
||||
project: fidelity
|
||||
updated: 2026-04-17
|
||||
tags:
|
||||
- map
|
||||
- onboarding
|
||||
---
|
||||
|
||||
# Start Here
|
||||
|
||||
Use this note as the entry point when opening `project-knowledge/` as the Obsidian vault.
|
||||
|
||||
This vault is the Fidelity project second brain. It is meant to be useful to the engineer, a new teammate, or an AI agent consuming project context. Agent implementation rules live outside this vault in `agent-memory/`.
|
||||
|
||||
---
|
||||
|
||||
## New Members
|
||||
|
||||
Read these first:
|
||||
|
||||
1. [New Member Onboarding](onboarding.md)
|
||||
2. [Glossary](glossary.md)
|
||||
3. [Current Work Map](../07-maps/current-work.md)
|
||||
4. [Fidelity Domain Map](../07-maps/fidelity-domain.md)
|
||||
5. [Fidelity Apps Map](../07-maps/fidelity-apps.md)
|
||||
6. [People Map](../07-maps/people.md)
|
||||
|
||||
---
|
||||
|
||||
## Current Work
|
||||
|
||||
- [Current State](../01-current/current-work.md)
|
||||
- [Active Work Items](../01-current/work-items.md)
|
||||
- [Work Item Index](../02-work-items/index.md)
|
||||
- [Daily Notes Index](../06-daily/index.md)
|
||||
|
||||
---
|
||||
|
||||
## Stable Context
|
||||
|
||||
- [Project Context](../03-context/project.md)
|
||||
- [Context Index](../03-context/index.md)
|
||||
- [Systems Index](../03-context/systems/index.md)
|
||||
- [Workstreams Index](../03-context/workstreams/index.md)
|
||||
- [People Index](../04-people/index.md)
|
||||
- [Manager Mapping](../04-people/manager.md)
|
||||
- [Decisions](../05-decisions/rest-vs-graphql.md)
|
||||
|
||||
---
|
||||
|
||||
## Project-Facing Process
|
||||
|
||||
- [Communication](../03-context/process/communication.md)
|
||||
- [Communication Rules](../03-context/process/communication-rules.md)
|
||||
- [Jira Story Rules](../03-context/process/jira-story-rules.md)
|
||||
- [Pull Requests](../03-context/process/pull-requests.md)
|
||||
|
||||
---
|
||||
|
||||
## Maps
|
||||
|
||||
- [Knowledge Maps](../07-maps/index.md)
|
||||
- [Current Work](../07-maps/current-work.md)
|
||||
- [Fidelity Domain](../07-maps/fidelity-domain.md)
|
||||
- [Fidelity Apps](../07-maps/fidelity-apps.md)
|
||||
- [Work Items](../07-maps/work-items.md)
|
||||
- [People](../07-maps/people.md)
|
||||
|
||||
---
|
||||
|
||||
## Daily Notes
|
||||
|
||||
Daily notes live in:
|
||||
|
||||
```text
|
||||
project-knowledge/06-daily/
|
||||
```
|
||||
|
||||
Use the latest dated note for recent evidence, but promote durable facts into `01-current/`, `02-work-items/`, or `03-context/` when they should survive beyond the day.
|
||||
|
||||
---
|
||||
|
||||
## Evidence Boundary
|
||||
|
||||
Inbox and generated files are evidence, not durable memory by default.
|
||||
|
||||
- `ai/inbox/`
|
||||
- `scripts/mattermost/generated/`
|
||||
- `scripts/slack/generated/`
|
||||
|
||||
Promote only high-confidence, project-relevant facts into this vault.
|
||||
Reference in New Issue
Block a user