summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSzymon Szukalski <szymon@szymonszukalski.com>2026-04-09 09:30:06 +1000
committerSzymon Szukalski <szymon@szymonszukalski.com>2026-04-09 09:30:06 +1000
commita9cb41ef7ae6fbd46dc6ff446c86b5df08f324b3 (patch)
treeb54f9306f95f272269d8dbea31d09d5e6af7921d /README.md
parent018c70ae0ba8a8c3a7ece3a10fb0be2199e3af96 (diff)
Rename people commands to crm
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 15 insertions, 11 deletions
diff --git a/README.md b/README.md
index 6d70f82..ed1edae 100644
--- a/README.md
+++ b/README.md
@@ -92,13 +92,16 @@ The minibuffer stack is intentionally small:
The people workflow is a CRM rooted at `~/org/areas/people/people.org`.
- Each top-level heading represents one person.
-- Entries are strictly structured around heading text and properties.
+- Entries are strictly structured around heading text and flat properties.
- The system generates abbrevs from the people file.
- The system provides canonical-name completion through a CAPF.
- The system provides reporting views grouped by person properties.
- The system rebuilds on any people-file change, whether the change comes from manual editing or from a command.
- The system must remain up to date after changes.
- Failures must surface visibly. The system must not silently fall back to stale state.
+- The CRM is individual-focused: `TEAM` captures the current working team and `MANAGER` captures the formal organisational manager.
+- Team structure, org charts, and matrix relationships belong in separate notes, not in the CRM.
+- Person cards use `ROLE`, `TEAM`, `MANAGER`, `ENGAGEMENT`, `LOCATION`, and `CURRENT_FOCUS` in that order.
- `CURRENT_FOCUS` must stay short and phrase-like so summaries and completion annotations remain readable.
Name entry uses fixed abbrevs plus the people CRM:
@@ -106,14 +109,14 @@ Name entry uses fixed abbrevs plus the people CRM:
- `abbrev` provides deterministic one-shot shortcuts for fixed name expansions.
- people-specific abbrevs are generated from top-level cards in `~/org/areas/people/people.org`.
- a CAPF feeds Corfu canonical names from `~/org/areas/people/people.org`, while alias matching stays available for lookup and completion.
-- Marginalia annotates person candidates with `role | location | engagement | current focus`.
-- `M-x ss/people-open` opens `~/org/areas/people/people.org` in overview mode through `ss/people-overview`.
-- `M-x ss/people-find` opens a person card narrowed to that subtree.
-- `M-x ss/people-overview` opens the people file in overview mode, resetting the file by widening and restoring the overview when leaving card view.
-- `M-x ss/people-insert-name` inserts the canonical name at point.
-- `M-x ss/people-insert-summary` inserts a compact single-line summary at point.
-- `M-x ss/people-add` adds a new person card directly to `~/org/areas/people/people.org`.
-- `M-x ss/people-report-by-relationship`, `M-x ss/people-report-by-engagement`, `M-x ss/people-report-by-role`, and `M-x ss/people-report-by-location` render grouped Org reports in a read-only buffer.
+- Marginalia annotates person candidates with `role | team | engagement | current focus`.
+- `M-x ss/crm-open` opens `~/org/areas/people/people.org` in overview mode through `ss/crm-overview`.
+- `M-x ss/crm-find` opens a person card narrowed to that subtree.
+- `M-x ss/crm-overview` opens the people file in overview mode, resetting the file by widening and restoring the overview when leaving card view.
+- `M-x ss/crm-insert-name` inserts the canonical name at point.
+- `M-x ss/crm-insert-summary` inserts a compact single-line summary at point.
+- `M-x ss/crm-add` adds a new person card directly to `~/org/areas/people/people.org`.
+- `M-x ss/crm-report-by-role`, `M-x ss/crm-report-by-team`, `M-x ss/crm-report-by-manager`, `M-x ss/crm-report-by-engagement`, and `M-x ss/crm-report-by-location` render grouped Org reports in a read-only buffer.
### Persistent abbrevs
@@ -199,7 +202,7 @@ Journal task capture writes under the current day's `Tasks` heading. Journal not
Denote captures still prompt for title, keywords, and subdirectory placement where appropriate, but folder placement does most of the classification work. The project capture template prepopulates the `project` keyword. Area and resource captures do not inject structural keywords automatically, and there is no Denote-backed meeting capture template.
-The people CRM is intentionally outside `org-capture`: `M-x ss/people-add` writes a compact card directly into `~/org/areas/people/people.org`, keeping the people file as a fast reference file instead of another capture sink.
+The people CRM is intentionally outside `org-capture`: `M-x ss/crm-add` writes a compact card directly into `~/org/areas/people/people.org`, keeping the people file as a fast reference file instead of another capture sink.
### Note creation and linking
@@ -218,7 +221,8 @@ Denote handles long-lived notes. The main bindings are:
- `C-c n O` to show people grouped by role.
- `C-c n p` to open `~/org/areas/people/people.org`.
- `C-c n P` to add a new person card.
-- `C-c n R` to show people grouped by relationship.
+- `C-c n R` to show people grouped by manager.
+- `C-c n T` to show people grouped by team.
Keyword prompts and directory placement are part of the workflow, not an afterthought. The config is set up so structure is created first, then capture writes into it, with folder placement carrying most of the durable type information.