102 lines
2.0 KiB
Markdown
102 lines
2.0 KiB
Markdown
# Create A Project Profile
|
|
|
|
Use this checklist when adapting the workspace core for a new project.
|
|
|
|
---
|
|
|
|
## 1. Create The Profile
|
|
|
|
Create:
|
|
|
|
```text
|
|
profiles/<project>/profile.md
|
|
profiles/<project>/README.md
|
|
```
|
|
|
|
The profile should declare:
|
|
|
|
- project name
|
|
- workspace purpose
|
|
- primary audience
|
|
- communication sources
|
|
- ticket/work-item system
|
|
- manager or stakeholder mapping
|
|
- active context files
|
|
- enabled commands
|
|
- enabled skills
|
|
|
|
---
|
|
|
|
## 2. Configure Context
|
|
|
|
Create or update:
|
|
|
|
```text
|
|
ai/context/project.md
|
|
ai/context/index.md
|
|
ai/context/process/
|
|
ai/context/people/
|
|
ai/state/current.md
|
|
ai/state/work-items.md
|
|
ai/work-items/index.md
|
|
```
|
|
|
|
Keep project-specific facts out of `core/`.
|
|
|
|
---
|
|
|
|
## 3. Configure Integrations
|
|
|
|
Use generic variables first:
|
|
|
|
```text
|
|
AIW_PROJECT_PROFILE=<project>
|
|
AIW_CHANNEL_PREFIX=<project-or-team-prefix>
|
|
AIW_MATTERMOST_SYNC_CMD=<optional custom command>
|
|
AIW_SLACK_EXPORT_PATH=<optional archive path>
|
|
```
|
|
|
|
Connector secrets belong in ignored `.env` files, not in profile files.
|
|
|
|
---
|
|
|
|
## 4. Configure Commands And Skills
|
|
|
|
Start with generic commands:
|
|
|
|
- `/workspace-context`
|
|
- `/communication-sync`
|
|
- `/archive-import`
|
|
- `/standup`
|
|
- `/manager-update`
|
|
- `/translate`
|
|
- `/ai-prompt`
|
|
|
|
Add project-specific aliases only when they reduce friction.
|
|
|
|
---
|
|
|
|
## 5. Validate
|
|
|
|
Before using the workspace for real work:
|
|
|
|
- confirm `opencode.json` is valid JSON
|
|
- confirm the profile has no secrets
|
|
- run a communication sync with test channels or a dry sample
|
|
- generate one standup from sample context
|
|
- verify that imported evidence and promoted memory stay separate
|
|
|
|
---
|
|
|
|
## 6. Optional Obsidian Vault
|
|
|
|
Open the workspace root as an Obsidian vault when you want a visual/manual navigation layer.
|
|
|
|
Recommended rules:
|
|
|
|
- keep the workspace filesystem as the single source of truth
|
|
- do not copy memory into a separate Obsidian-only folder
|
|
- version only portable `.obsidian` configuration
|
|
- ignore local Obsidian workspace state and plugin runtime files
|
|
- create or update a vault map under `knowledge/` for human navigation
|