Create a regional or LP-level handbook for shared content
Objective
- Provide a handbook space for content shared across brands (regional or LP level) so onboarding, training, and other universal material is maintained once and consumed everywhere it applies.
- Reduce duplicate SOPs and training docs copied into each company’s Office or Inspector handbook.
- Extend the Company Handbook initiative beyond per-company, per-team spaces (e.g. Office, Inspector, and planned team handbooks).
Background
- Operations and leadership need a place for material that is similar or universal across the company — not tied to a single brand’s
_companyId. - Today, Attik handbooks are company-scoped: every help doc row includes
_companyId, and the UI only exposes fixed team handbooks (office,inspector) per company login. - There is no regional, LP-parent, or multi-brand handbook in the product today; this is new capability, not a broken existing feature.
- Part of the broader Company Handbook epic (parent ATT-1725).
- Related but separate work: team-specific handbooks inside one company (e.g. Growth, Client Success in ATT-1712) add more local spaces; this work is about cross-brand shared content.
Scope
Product / data model (decision needed)
- Define what “regional or LP-level” means in Attik: LP parent org, explicit brand group, read-only inheritance vs single shared library, who can author vs view.
- Decide how shared docs relate to existing
help-docsvshandbooklistvalues onhelpDocSchema.
Backend (attik-backend)
src/models/helpDocSchema.ts— all documents require_companyId;listenum is'help-docs' | 'handbook'only; no org/LP/region field.src/routes/helpdoc.ts— list/create/update filtered byreq.query._companyId/res.locals.company._id.src/util/data/permissionsData.ts— handbook permissions (handbook,handbook-office,handbook-inspector,handbook-admin) are per user/company role, not cross-brand.src/util/functions/ai/syncHelpdocsToAIChunks.ts— indexes helpdoc URLs per company context; may need scope if shared content is searchable across brands.
Frontend (attik-frontend)
src/app/tools/handbook/[[...id]]/page.tsx— routing limited toofficeandinspector; other slugs return 404.src/util/data/navButtons.tsx— Company Handbook subnav is Office + Inspector only.- Supporting components (
HelpDocBase.tsx,HelpDocForm.tsx,DraftSheets.tsx, etc.) parameterized byhandbookSlug— new slug(s) would need to flow through if added. next.config.js— legacy/help-docsredirects to/handbook.
Out of scope (unless product expands)
- Duplicating the same article into every child company handbook manually (status quo workaround).
- Mobile handbook UI (no handbook surface found in
attik-mobile). - Replacing per-brand Office/Inspector handbooks — those remain company-local.
Constraints
- Shared content should be clearly distinguishable from brand-specific handbooks in nav and permissions.
- Decision needed: edit rights at LP vs brand admin vs read-only at child companies.
References
- Parent epic: Company Handbook (ATT-1725)
- Per-team company handbooks (related): ATT-1712
- Handbook router:
attik-frontend/src/app/tools/handbook/[[...id]]/page.tsx - Help doc model/API:
attik-backend/src/models/helpDocSchema.ts,attik-backend/src/routes/helpdoc.ts - Handbook permissions:
attik-backend/src/util/data/permissionsData.ts
Status: Planned
Log in to comment and vote
No comments yet
Be the first to share your thoughts.