Skip to content

Commit 773e512

Browse files
authored
Merge pull request #117 from nold-ai/feature/docs-11-team-enterprise-tier
docs: add team and enterprise guides
2 parents 17befb5 + fb23a36 commit 773e512

13 files changed

Lines changed: 716 additions & 102 deletions

File tree

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@ The modules site owns all bundle-specific deep guidance. Core CLI platform docs
3535
- [Project DevOps Flow](bundles/project/devops-flow/)
3636
- [DevOps Adapter Integration](integrations/devops-adapter-overview/)
3737

38+
## Team And Enterprise
39+
40+
- [Team Collaboration Setup](team-and-enterprise/team-collaboration/)
41+
- [Agile And Scrum Team Setup](team-and-enterprise/agile-scrum-setup/)
42+
- [Multi-Repo Setup](team-and-enterprise/multi-repo/)
43+
- [Enterprise Configuration](team-and-enterprise/enterprise-config/)
44+
3845
## Authoring
3946

4047
- [Module Development](authoring/module-development/)
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
layout: default
3+
title: Agile And Scrum Team Setup
4+
permalink: /team-and-enterprise/agile-scrum-setup/
5+
redirect_from:
6+
- /guides/agile-scrum-workflows/
7+
---
8+
9+
# Agile And Scrum Team Setup
10+
11+
This playbook translates the backlog and project-bundle commands into team onboarding steps for Scrum and Kanban groups.
12+
13+
## 1. Choose the team bootstrap profile
14+
15+
```bash
16+
specfact init --profile backlog-team
17+
specfact init ide --repo . --ide cursor
18+
```
19+
20+
For API-heavy teams that also own contract workflows, move to `api-first-team` instead.
21+
22+
## 2. Configure the team’s backlog operating model
23+
24+
Primary ceremony commands:
25+
26+
```bash
27+
specfact backlog ceremony standup github
28+
specfact backlog ceremony refinement github --preview --labels feature
29+
specfact backlog verify-readiness --adapter github --project-id owner/repo --target-items 123
30+
```
31+
32+
Use standup for daily visibility, refinement for standardization, and verify-readiness before sprint commitment or release planning.
33+
34+
## 3. Scrum setup
35+
36+
Use Scrum when the team commits to iterations and wants readiness checks before sprint planning:
37+
38+
- Run standup against the active sprint or iteration
39+
- Refine backlog items before they enter sprint planning
40+
- Validate readiness before commitment
41+
- Export persona-owned plan views when product, architecture, and development need separate edit streams
42+
43+
## 4. Kanban setup
44+
45+
Use Kanban when the team works from a continuous queue:
46+
47+
- Run standup without sprint filters
48+
- Use refinement continuously on incoming work
49+
- Use readiness checks on pull-ready or release-candidate items
50+
- Keep unassigned work visible for pull-based planning
51+
52+
## 5. Shared team rollout for prompts and templates
53+
54+
Backlog refinement and standup support bundle-owned prompts and templates. Keep them aligned through installed module versions and re-bootstrap the IDE exports after upgrades:
55+
56+
```bash
57+
specfact module upgrade
58+
specfact init ide --repo . --ide cursor --force
59+
```
60+
61+
## Related
62+
63+
- [Team Collaboration Setup](/team-and-enterprise/team-collaboration/)
64+
- [Backlog bundle overview](/bundles/backlog/overview/)
65+
- [Workflows](/workflows/)
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
layout: default
3+
title: Enterprise Configuration
4+
permalink: /team-and-enterprise/enterprise-config/
5+
---
6+
7+
# Enterprise Configuration
8+
9+
This guide covers the configuration levers most relevant to enterprise rollouts: profiles, central registry policy, project-scoped bootstrap, and domain-specific overlays managed in repository configuration.
10+
11+
## 1. Start from an enterprise profile
12+
13+
```bash
14+
specfact init --profile enterprise-full-stack
15+
specfact init ide --repo . --ide cursor
16+
```
17+
18+
This profile installs the broadest official command surface for teams that need project, backlog, code, spec, and govern flows together.
19+
20+
## 2. Manage registries centrally
21+
22+
Use custom registries when teams consume an internal mirror or approved company modules:
23+
24+
```bash
25+
specfact module add-registry https://company.example.com/specfact/registry/index.json --id company --priority 10 --trust always
26+
specfact module list-registries
27+
```
28+
29+
Combine this with project or workstation provisioning so teams see the same registry ordering and trust policy.
30+
31+
## 3. Use project-scoped bootstrap for domain overlays
32+
33+
Enterprise teams often need repository-local overlays on top of the shared company baseline. The supported approach is to keep shared module versions central while letting individual repositories bootstrap their own module root and IDE exports:
34+
35+
```bash
36+
specfact module init --scope project --repo .
37+
specfact init ide --repo . --ide cursor --force
38+
```
39+
40+
Treat those repo-local artifacts as the domain overlay layer for a given service or business unit.
41+
42+
## 4. Keep bundle-owned resources versioned
43+
44+
Prompts and workspace templates ship from installed bundles. Enterprise rollout should therefore version the bundles, not copied prompt files:
45+
46+
- approve bundle versions centrally
47+
- upgrade with `specfact module upgrade`
48+
- refresh project-facing exports with `specfact init ide --force`
49+
50+
## 5. Non-official publisher policy
51+
52+
If the enterprise uses private or third-party registries, make the trust model explicit in automation and workstation setup. For non-official publishers, use the documented trust controls rather than bypassing the module lifecycle.
53+
54+
## Related
55+
56+
- [Multi-Repo Setup](/team-and-enterprise/multi-repo/)
57+
- [Custom registries](/authoring/custom-registries/)
58+
- [Module marketplace](/guides/module-marketplace/)
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
layout: default
3+
title: Multi-Repo Setup
4+
permalink: /team-and-enterprise/multi-repo/
5+
---
6+
7+
# Multi-Repo Setup
8+
9+
Use this guide when one team manages several repositories that share the same module stack or bundle rollout policy.
10+
11+
## 1. Standardize the bootstrap across repos
12+
13+
Use the same profile in each repository:
14+
15+
```bash
16+
specfact init --profile enterprise-full-stack
17+
specfact init ide --repo . --ide cursor
18+
specfact module init --scope project --repo .
19+
```
20+
21+
This gives each repo the same baseline while still allowing repository-local artifacts.
22+
23+
## 2. Use `--repo` explicitly for repository-specific actions
24+
25+
Commands that support `--repo` should point to the active repository when automation runs across several working copies:
26+
27+
```bash
28+
specfact project export --repo /workspace/service-a --bundle service-a --persona architect --stdout
29+
specfact project import --repo /workspace/service-b --bundle service-b --persona developer --input docs/project-plans/developer.md --dry-run
30+
specfact project sync bridge --adapter github --mode export-only --repo /workspace/service-a --bundle service-a
31+
```
32+
33+
## 3. Keep shared module rollout predictable
34+
35+
Prompts and templates come from installed bundles, so multi-repo teams should align on:
36+
37+
- the profile used for first bootstrap
38+
- the module versions promoted across repositories
39+
- when `specfact init ide --force` is re-run after upgrades
40+
41+
## 4. Use repo-local overrides where needed
42+
43+
Project-scope module bootstrap is the safe place for repo-specific behavior:
44+
45+
```bash
46+
specfact module init --scope project --repo /workspace/service-a
47+
```
48+
49+
Use that when one repository needs additional local artifacts without changing the user-scoped defaults for every repo on a developer workstation.
50+
51+
## Related
52+
53+
- [Enterprise Configuration](/team-and-enterprise/enterprise-config/)
54+
- [Team Collaboration Setup](/team-and-enterprise/team-collaboration/)
55+
- [Project bundle overview](/bundles/project/overview/)
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
layout: default
3+
title: Team Collaboration Setup
4+
permalink: /team-and-enterprise/team-collaboration/
5+
redirect_from:
6+
- /guides/team-collaboration-workflow/
7+
---
8+
9+
# Team Collaboration Setup
10+
11+
This guide is for team leads who are rolling out SpecFact across a shared repository or a small set of team-owned repositories.
12+
13+
## 1. Bootstrap the team profile
14+
15+
Start from a team-oriented profile instead of a solo-developer bootstrap:
16+
17+
```bash
18+
specfact init --profile backlog-team
19+
specfact init ide --repo . --ide cursor
20+
```
21+
22+
Use `backlog-team` for shared backlog and project-bundle workflows. Re-run `specfact init ide` after bundle upgrades so every developer gets the same prompt and template set from the installed modules.
23+
24+
## 2. Initialize project-scoped module artifacts
25+
26+
```bash
27+
specfact module init --scope project --repo .
28+
specfact project init-personas --bundle legacy-api --no-interactive
29+
```
30+
31+
Use project scope when the team wants repository-local bootstrap artifacts instead of per-user defaults. `init-personas` ensures the shared bundle has the expected persona mappings before collaboration begins.
32+
33+
## 3. Establish shared role workflows
34+
35+
Typical role ownership:
36+
37+
- Product Owner: backlog content, readiness, prioritization
38+
- Architect: constraints, contracts, deployment and risk
39+
- Developer: implementation details, task mapping, definition of done
40+
41+
Export and import flows for each role:
42+
43+
```bash
44+
specfact project export --bundle legacy-api --persona product-owner --output-dir docs/project-plans
45+
specfact project import --bundle legacy-api --persona product-owner --input docs/project-plans/product-owner.md --dry-run
46+
```
47+
48+
Repeat the same pattern for `architect` and `developer`.
49+
50+
## 4. Protect concurrent edits with locks
51+
52+
```bash
53+
specfact project locks --bundle legacy-api
54+
specfact project lock --bundle legacy-api --section idea --persona product-owner
55+
```
56+
57+
Lock high-contention sections before edits, then unlock after import. This prevents overlapping changes when several personas work in parallel.
58+
59+
## 5. Merge branch-level bundle edits safely
60+
61+
```bash
62+
specfact project merge \
63+
--bundle legacy-api \
64+
--base main \
65+
--ours feature/product-owner-updates \
66+
--theirs feature/architect-updates \
67+
--persona-ours product-owner \
68+
--persona-theirs architect
69+
```
70+
71+
Use persona-aware merge when branches diverged on the same bundle but the changes came from different owners.
72+
73+
## 6. Keep bundle-owned prompts and templates aligned
74+
75+
Prompts and workspace templates are bundle-owned resources, not core-owned files. Team rollout should use installed module versions plus the supported bootstrap commands:
76+
77+
```bash
78+
specfact module upgrade
79+
specfact init ide --repo . --ide cursor --force
80+
```
81+
82+
## Recommended team cadence
83+
84+
1. Bootstrap one repo with `backlog-team`.
85+
2. Initialize personas and project-scope module artifacts.
86+
3. Export persona views into a shared docs or planning directory.
87+
4. Require locks for high-contention sections.
88+
5. Refresh IDE resources whenever module versions change.
89+
90+
## Related
91+
92+
- [Agile/Scrum Team Setup](/team-and-enterprise/agile-scrum-setup/)
93+
- [Multi-Repo Setup](/team-and-enterprise/multi-repo/)
94+
- [Project bundle overview](/bundles/project/overview/)

0 commit comments

Comments
 (0)