Jira and Confluence Workflow
Jira Task Structure
Development Workflow
- Plan
- Design
- Development Planning
- Requirement analysis & discussion
- Create Jira tickets for development
- Gantt chart
- Integration
- Sequence diagram
- API specification
- Analyze previous code
- Design structure
- Create separated Jira tickets for each function
Confluence Document Structure
Categories
- Meeting: Meeting notes and discussions
- QnA: Questions and answers
- Research: Research documents
- Gantt chart: Timeline and scheduling
Integration
- Flow diagrams
- API specification
Development
- Structure documentation
Study and Documentation Habits
Coding Study
- Record in GitHub
Other Topics
- Record in blog
- When trying new services, take screenshots and notes, then organize for blog
Programming Study Approach
- Tutorial/Course -> Sample code
- Official Documentation -> Sample project
- Sample project -> Common library creation
Good resources should be organized in GitHub readme or GitHub wiki.
Programming Language Study Approach
- Development environment setup
- Syntax understanding -> Sample project creation
- Architecture -> Document organization and base library creation
- Framework -> Learn frameworks needed for architecture
- Sample projects
- Study required technologies
Documentation Tools
GitBook
API Specification Auto-generation
Gantt Chart Tools
- AUI Project
- Smartsheet
Jira Best Practices
Ticket Management
Effective Jira ticket management improves team productivity and traceability. Here are practical tips for managing tickets:
Writing Good Ticket Descriptions
A well-written Jira ticket should contain:
- Summary: A clear, concise title that describes the work
- Description: Context about why this work is needed
- Acceptance Criteria: Specific conditions that must be met for the ticket to be considered done
- Technical Notes: Implementation details or constraints the developer should know
Ticket Types and Hierarchy
| Type | Purpose | Example |
|---|---|---|
| Epic | A large body of work spanning multiple sprints | “User Authentication System” |
| Story | A user-facing feature or functionality | “As a user, I can reset my password” |
| Task | A technical work item | “Set up CI/CD pipeline” |
| Bug | A defect that needs fixing | “Login button unresponsive on mobile” |
| Sub-task | A smaller piece of work under a story or task | “Implement email validation” |
Workflow States
A typical development workflow in Jira follows these states:
- Backlog → The ticket is created but not yet planned
- To Do → The ticket is planned for the current sprint
- In Progress → A developer is actively working on it
- In Review → The code is submitted for review
- QA → Quality assurance testing is in progress
- Done → The work is complete and deployed
Confluence Best Practices
Document Organization
A well-organized Confluence space makes information easy to find:
- Use a consistent page hierarchy: Group pages by project, team, or topic
- Create templates: Standardize meeting notes, design documents, and post-mortems
- Use labels: Tag pages with relevant labels for cross-cutting concerns
- Archive old content: Move outdated pages to an archive section rather than deleting them
Effective Technical Documentation
When writing technical documentation in Confluence:
- Start with context: Explain the problem before the solution
- Include diagrams: Use draw.io or Mermaid macros for architecture and flow diagrams
- Keep it updated: Stale documentation is worse than no documentation — assign owners for key documents
- Link to related resources: Connect Confluence pages to Jira tickets, GitHub PRs, and other relevant materials
Integration Between Jira and Confluence
One of the most powerful features is the integration between Jira and Confluence:
- Embed Jira filters in Confluence pages to show related tickets
- Link design documents in Confluence directly from Jira tickets
- Use Confluence blueprints to create requirement documents that reference Jira epics
- Create retrospective pages that pull sprint data from Jira automatically
Comments