Jira Task Structure

Development Workflow

  1. Plan
  2. Design
  3. Development Planning
    • Requirement analysis & discussion
    • Create Jira tickets for development
    • Gantt chart
  4. Integration
    • Sequence diagram
    • API specification
  5. Analyze previous code
  6. Design structure
  7. 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

  1. Tutorial/Course -> Sample code
  2. Official Documentation -> Sample project
  3. Sample project -> Common library creation

Good resources should be organized in GitHub readme or GitHub wiki.

Programming Language Study Approach

  1. Development environment setup
  2. Syntax understanding -> Sample project creation
  3. Architecture -> Document organization and base library creation
  4. Framework -> Learn frameworks needed for architecture
  5. Sample projects
  6. Study required technologies

Documentation Tools

GitBook

API Specification Auto-generation

Gantt Chart Tools