Skip to main content

​
DOCS Jira Ticket Template

Use this format when creating documentation tickets in the DOCS project (sukiai.atlassian.net).

​
Title / Summary

Descriptive title (e.g., “SDK Buffer Mechanism & Network Notification”)

​
Description

Paragraph explaining the purpose:
  • What documentation is being updated
  • What the feature/change enables for developers
  • High-level overview (layman’s terms)
Example:
To update the existing documentation for SDK users about the new buffer mechanism. This update enables developers to implement their own UI notifications, informing mobile users of network issues or fluctuations. In a very layman’s and high-level overview.
  • Parent Dev Ticket - [TICKET-KEY]: [Title] [Status if applicable] (e.g., MOBAPP-5686: Notification for Network Interruption - Buffer [iOS SDK] - READY FOR QA TEST)
  • PRD - N/A or link

​
Fix Version/s

Version number (e.g., v2.17.0)

​
Acceptance Criteria

  • Add a note in the relevant SDK documentation about the new feature, not so much technical.
  • Clearly explain how developers can use their own UI to notify users of network issues/fluctuations.
  • Ensure language follows the Suki Style Guide (clear, direct, developer-focused).
  • Review with Dev and PM for accuracy.
  • Content published in the correct SDK docs section.

​
Content Development

The TW will draft the documentation, working closely with the Dev and PM to clarify technical details as needed.

​
Create a Pull Request (PR)

  • Documentation changes will be made in source control.
  • TW creates a PR with the updated content.
  • PR description links back to this DOCS ticket.
Last modified on February 24, 2026