Skip to main content

Software Engineer’s Guide

Introduction​

This user journey is tailored for MDC Software Engineers, providing access to tools, standards and architecture resources to help navigate effectively and boost productivity.
Disclaimer: While other software engineers in JTI may use the documentation site for general guidance, certain tools and resources, such as the Internal Developer Portal (IDP), are exclusive to MDC team. The technologies presented reflect our recommended stack for internal projects.

✨ Step 1: Get Started​

  • About - Familiarize yourself with the platform structure and available resources.

🔧 Step 2: Explore Software Engineering Essentials​

  • Technology Radar: See current trends and recommendations on what to explore, adopt or avoid.
  • Principles & Practices: Explore best practices for reusability, component design and security.
  • Standards: Follow coding and styling guidelines for consistent, high-quality projects.

🛠️ Step 3: Leverage Tooling and DevOps Resources​

  • Development Lifecycle: Find resources for the full software development process.
  • DevOps Guidance: Explore top DevOps best practices, with references to adopted tools and methodologies.

🏗️ Step 4: Dive into Software Architecture​

  • Guidelines: Review architectural standards supporting scalable and maintainable solutions.
  • Reference Architecture: Access tailored templates for each app type, including IaC for consistent deployments.
  • Components Catalog: Explore a selection of templates, services and packages commonly used in our projects.

👨‍💻 Step 5: Access the Internal Developer Portal (IDP)​

  • The Internal Developer Portal (IDP) is your daily hub for hands-on resources, templates, components and dashboards exclusive to our internal team. After understanding our standards and practices, use the IDP to streamline your work, access ready-to-use tools and enhance your productivity.

❗Note: The IDP is exclusively available to the MDC team.