Documentation System¶
Centralized SOPs, Handbooks, and Reference Material¶
PulseRoster's Documentation system lets communities maintain SOPs, handbooks, 10-codes, penal codes, training manuals, and more — all inside PulseRoster instead of scattered across Google Docs, Notion, and Discord pins.
Document Types¶
PulseRoster supports three document types, each designed for a different use case:
Standard Document¶
Rich text documents with a full WYSIWYG editor. Use these for SOPs, handbooks, training manuals, policy documents, and anything that needs formatted text.
The editor supports:
- Headings (H1 through H6)
- Bold, italic, underline, strikethrough
- Ordered and unordered lists
- Links and images
- Tables
- Blockquotes
- Code blocks
Code Table¶
Structured reference tables designed for 10-codes, penal codes, vehicle codes, and similar reference material. Code tables provide:
| Feature | Description |
|---|---|
| Searchable Columns | Instantly filter rows by typing in the search bar |
| Category Badges | Color-coded badges for easy categorization |
| Click-to-Copy | Click any cell in a "Copy" column to copy its value |
| Templates | Quick-start with 10-Codes, Penal Codes, Vehicle Codes, or custom columns |
Checklist¶
Step-by-step checklists that members can check off individually. Useful for onboarding procedures, shift checklists, and training requirements. Progress tracking shows how far each member has gotten.
Key Features¶
Rich Text Editor¶
The editor provides a full formatting toolbar for Standard Documents. Write and format content without leaving PulseRoster.
Code Table Templates¶
When creating a Code Table, choose from built-in templates:
| Template | Columns |
|---|---|
| 10-Codes | Code, Description, Category |
| Penal Codes | Code, Title, Description, Classification |
| Vehicle Codes | Code, Description, Category |
| Custom | Define your own columns and types |
Folder Organization¶
Organize documents into folders and subfolders. Keep your documentation library structured as it grows.
Department-Scoped Documents¶
Documents can belong to a specific department or be community-wide:
| Scope | Visibility |
|---|---|
| Community-wide | All members with documentation permissions |
| Department | Only members of that department |
Version Control¶
Every time you publish a document, a new version is created.
- Version History shows who published each version and when
- Restore previous versions if needed
- Standard tier keeps the last 5 versions
- Professional tier keeps unlimited version history
Acknowledgment Tracking¶
Mark documents as "Requires Acknowledgment" to ensure members read critical documents.
| Feature | Description |
|---|---|
| Acknowledgment Status | Track which members have acknowledged per document |
| Member-by-Member View | See exactly who has and hasn't acknowledged |
| Version-Aware | Acknowledgments reset when a new version is published |
| Discord DM Reminders | Send reminders to members who haven't acknowledged (Professional) |
Required Reading Tracker¶
Documents that require acknowledgment appear prominently across PulseRoster:
- Community Dashboard — amber-highlighted section showing unacknowledged required documents
- Department Pages — department-specific required reading for that department's members
- Members can click through directly to read and acknowledge
Copy Protection¶
Toggle copy protection per document to prevent unauthorized copying of sensitive content. When enabled:
- Right-click is disabled on document content
- Ctrl+C / Cmd+C is blocked
- Text selection is disabled
Full-Text Search¶
Search across all documents by title and content. Results display highlighted snippets so you can quickly find what you need.
View Analytics (Professional)¶
Track engagement with your documents:
| Metric | Description |
|---|---|
| Total Views | How many times the document has been opened |
| Unique Viewers | How many distinct members have viewed it |
| Average Read Time | How long members spend reading |
| Scroll Depth | How far members scroll through the document |
.docx Import (Professional)¶
Import existing Word documents with full style mapping:
- Headings, bold, italic, and other formatting preserved
- Ordered and unordered lists converted
- Embedded images extracted and uploaded
- No manual reformatting needed
Discord Notifications (Professional)¶
Notify members via Discord when:
- A new document is published
- Acknowledgment is required on a new or updated document
Creating Documents¶
How to Create¶
- Navigate to Documentation from the sidebar
- Click New Document
- Enter a title and select a type (Standard, Code Table, or Checklist)
- For Code Tables, choose a template (10-Codes, Penal Codes, Vehicle Codes) or create custom columns
- Optionally assign to a department and/or folder
- Toggle Requires Acknowledgment if members need to confirm they've read it
- Click Create Document — you'll be taken to the editor
Document Fields¶
| Field | Description | Required |
|---|---|---|
| Title | Document name | Yes |
| Type | Standard, Code Table, or Checklist | Yes |
| Department | Assign to a department or leave community-wide | No |
| Folder | Place in a folder for organization | No |
| Requires Acknowledgment | Members must acknowledge after reading | No |
| Copy Protection | Prevent text copying | No |
Publishing¶
Documents start as drafts. When ready, click Publish to:
- Snapshot the current content as a new version
- Make the document visible to all members
- If acknowledgment is required, reset acknowledgment tracking for the new version
Draft vs. Published
Drafts are only visible to document editors. Published documents are visible to all members with the documentation.view permission.
Subscription Tiers¶
| Feature | Free | Standard | Professional |
|---|---|---|---|
| Documentation | — | Up to 25 documents | Unlimited |
| Folders | — | Up to 10 | Unlimited |
| Code Tables | — | Up to 3 | Unlimited |
| Version History | — | Last 5 versions | Unlimited |
| Checklist Type | — | — | Yes |
| .docx Import | — | — | Yes |
| View Analytics | — | — | Yes |
| Discord Notifications | — | — | Yes |
| Certification Integration | — | — | Yes |
Permissions¶
Documentation permissions are managed through Staff Roles. See Permissions & Staff Roles for full details.
| Permission | Description |
|---|---|
documentation.view |
View published documents |
documentation.create |
Create new documents |
documentation.edit |
Edit existing documents |
documentation.delete |
Delete documents |
documentation.publish |
Publish document versions |
documentation.manage_acknowledgments |
View and manage acknowledgment status |
Tips and Best Practices¶
- Table of Contents — Use the Table of Contents on the left side of the reader for quick navigation through long documents
- Code Table Filters — Code Tables support a Filter column (badge type) for easy categorization and filtering
- Copy Column — The Copy column option in Code Tables lets readers click to copy cell values instantly
- Required Reading Visibility — Documents that require acknowledgment show an amber banner on the community dashboard and department pages until acknowledged
- Organize Early — Set up a folder structure before creating many documents to keep things manageable
- Department Scoping — Use department-scoped documents for department-specific SOPs so members only see what's relevant to them
Quick Reference¶
Documentation URLs¶
| Page | URL |
|---|---|
| Documentation List | /c/[slug]/documentation |
| Document Reader | /c/[slug]/documentation/[doc-slug] |
Required Permissions¶
| Action | Permission |
|---|---|
| View documents | documentation.view |
| Create documents | documentation.create |
| Edit documents | documentation.edit |
| Delete documents | documentation.delete |
| Publish versions | documentation.publish |
| Manage acknowledgments | documentation.manage_acknowledgments |
Need help? Join our Discord Community for support.