Master this essential documentation concept
The ability to define user access levels and capabilities by creating custom roles with specific permissions rather than using only preset role templates.
Custom Roles & Permissions empower documentation teams to move beyond one-size-fits-all access controls by defining precisely what each contributor, reviewer, or stakeholder can see and do within a documentation platform. Instead of forcing users into rigid preset categories like 'Admin' or 'Viewer,' teams can craft roles that mirror their actual workflows and organizational structures.
A documentation team regularly hires freelance technical writers who need access to specific product docs but must not view confidential roadmap documentation, internal pricing guides, or other restricted content across the platform.
Create a 'Contractor Writer' custom role scoped to specific projects only, with permissions to create and edit drafts but not publish, and explicitly excluding access to restricted portals or document categories.
1. Identify which projects contractors will work on and list required actions (create, edit, save drafts). 2. Create a 'Contractor Writer' role with edit permissions limited to assigned projects. 3. Disable publish, delete, and admin permissions entirely for this role. 4. Set project-level access restrictions so contractors only see their assigned portal. 5. Enable automatic role expiration after contract end date. 6. Assign all contractors to this role upon onboarding.
Contractors can contribute effectively without exposure to sensitive content, offboarding is simplified by role expiration, and the team maintains a clean audit trail of contractor activity.
Engineers, product managers, and other SMEs need to review and comment on technical documentation for accuracy, but giving them full edit access leads to formatting inconsistencies, accidental overwrites, and disrupted documentation workflows.
Create a 'SME Reviewer' custom role that grants comment and suggestion permissions only, allowing SMEs to annotate content and propose changes without directly editing the master document.
1. Define a 'SME Reviewer' role with read and comment permissions only. 2. Enable 'suggest changes' or annotation features if the platform supports it. 3. Restrict publish, delete, and structural editing capabilities. 4. Assign SMEs to this role for specific documentation projects relevant to their expertise. 5. Configure notifications so technical writers are alerted when SME comments are added. 6. Establish a review workflow where writers incorporate feedback and mark comments as resolved.
SMEs contribute accurate technical knowledge without disrupting documentation structure, writers maintain control over final content quality, and the review cycle becomes faster and more organized.
A global company has documentation teams in North America, Europe, and Asia-Pacific, each responsible for their own regional product documentation. Teams need autonomy over their content but should not accidentally modify or publish content belonging to other regions.
Create region-specific roles such as 'NA Documentation Editor,' 'EU Documentation Editor,' and 'APAC Documentation Editor,' each with full edit and publish permissions scoped exclusively to their respective regional portals.
1. Map out regional portal structure and identify which teams own which portals. 2. Create a base 'Regional Editor' role template with standard edit and publish permissions. 3. Clone the template to create region-specific variants and scope each to the appropriate portal. 4. Create a 'Global Documentation Manager' role with cross-portal read access and admin capabilities. 5. Assign team members to their respective regional roles. 6. Set up cross-regional 'read-only' permissions so teams can reference each other's content without editing it.
Regional teams operate independently without risk of cross-contamination, global managers maintain oversight, and content governance becomes scalable as the company expands to new regions.
A healthcare or financial services company must ensure all documentation passes through legal and compliance review before publication. Without structured permissions, writers can accidentally publish unreviewed content, creating regulatory and liability risks.
Create a tiered role system with 'Documentation Author,' 'Content Reviewer,' 'Compliance Approver,' and 'Publication Manager' roles, where each role unlocks the next stage of the publishing workflow.
1. Map the required approval stages: Draft → Review → Compliance Check → Publish. 2. Create 'Documentation Author' role with create and edit permissions, but no publish rights. 3. Create 'Content Reviewer' role with read, comment, and status-change permissions to mark content as reviewed. 4. Create 'Compliance Approver' role with approval permissions that unlock the publish stage. 5. Create 'Publication Manager' role as the only role with publish and archive permissions. 6. Configure workflow notifications at each stage transition. 7. Enable audit logging to record who approved and published each document.
No content reaches end users without passing through all required approval stages, compliance requirements are met consistently, and the audit trail satisfies regulatory documentation requirements.
Before creating roles in your platform, map out your team's actual workflows, responsibilities, and access needs on paper or in a spreadsheet. Understanding who does what and why prevents role sprawl and ensures your permission structure reflects reality rather than assumptions.
Every user should have only the minimum permissions necessary to complete their job responsibilities. Over-provisioning access is one of the most common and consequential mistakes in permission management, leading to accidental content changes, unauthorized publishing, or data exposure.
Team structures, project scopes, and individual responsibilities change frequently. Permissions that were appropriate six months ago may now be excessive or insufficient. Regular audits ensure your role structure stays aligned with current organizational reality and reduces security risks from stale access.
Ambiguous role names like 'User,' 'Editor2,' or 'New Role' create confusion when onboarding team members or troubleshooting access issues. A clear, consistent naming convention makes role management intuitive and reduces the likelihood of assigning the wrong role to a user.
Newly created roles often have gaps or unintended restrictions that only become apparent when users try to complete their actual tasks. Testing roles with representative team members before full deployment prevents workflow disruptions and ensures permissions are correctly calibrated.
Join thousands of teams creating outstanding documentation
Book a Demo