How to Set Up MadCap Pulse (Formerly MadCap Feedback Server)

Best Practices for Using MadCap Pulse (Formerly MadCap Feedback Server)

1. Plan your feedback workflow

• Define roles: Assign reviewers, approvers, and administrators with clear responsibilities.
• Set stages: Use stages (e.g., Draft → Review → Approved) to track status and prevent premature publishing.
• Establish SLAs: Create expected response times for reviewers to keep cycles short.

2. Organize projects and topics logically

• Use consistent naming: Apply a clear, consistent naming convention for projects, builds, and topics.
• Group related content: Keep related topics and builds together to make feedback contextually relevant.
• Archive old builds: Remove or archive obsolete builds to reduce clutter.

3. Provide clear instructions for reviewers

• Onboard reviewers: Offer a short guide or template showing how to add comments, set priorities, and tag issues.
• Encourage actionable comments: Ask reviewers to include expected outcomes, reproduction steps, or suggested wording.
• Use tags/labels: Standardize tags (e.g., typo, technical, UX, urgent) so issues are easier to filter and triage.

4. Use annotations and screenshots effectively

• Annotate precisely: Encourage pinning comments to exact text or UI elements to reduce ambiguity.
• Attach screenshots: Require screenshots for UI/visual issues; use highlight tools or arrows to show the exact problem.
• Include environment details: For bugs, include browser, OS, and build version.

5. Triage and prioritize systematically

• Daily or regular triage: Have a designated person review incoming feedback and assign priority, owner, and status.
• Prioritization criteria: Base priority on user impact, frequency, and effort to fix.
• Link to work items: Integrate with your issue tracker or link feedback to Jira/Trello tickets for development work.

6. Communicate resolution and close loops

• Acknowledge submissions: Let reviewers know their feedback was received and assigned.
• Comment on fixes: When an issue is resolved, comment with the resolution and build number so the reporter can verify.
• Close confirmed items: Close items only after reporter confirms the fix or after a defined verification step.

7. Maintain security and access control

• Limit access by role: Grant only necessary permissions—readers, reviewers, and full admins—based on needs.
• Use single sign-on: If available, integrate SSO for easier management and audit trails.
• Regular audits: Periodically review user access and remove inactive accounts.

8. Integrate with your documentation process

• Embed feedback in CI/CD: Trigger builds and notify reviewers automatically after content updates.
• Sync with source control: Ensure feedback references the correct source files or commits.
• Use feedback for metrics: Track number of issues, turnaround time, and common problem types to improve content quality.

9. Train contributors and maintain governance

• Run short training sessions: Show new authors and reviewers how to use Pulse effectively.
• Create style and review guidelines: Document editorial standards and review expectations.
• Enforce periodic reviews: Schedule recurring reviews for high-visibility content.

10. Monitor and iterate

• Collect feedback on the process: Periodically ask users about their experience with Pulse and adjust workflows.
• Measure KPIs: Monitor average time-to-resolution, open vs. closed ratio, and reviewer responsiveness.
• Continuous improvement: Update tags, templates, and processes based on metrics and user feedback.