Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 4.82 KB

File metadata and controls

63 lines (49 loc) · 4.82 KB
title Developer Tutorials
layout page
icon fa-check
hide true

{% include image.html max-width="100%" height="auto" background-size="cover" file="assets/images/undraw_Programming_re_kg9v.png" alt="Dev Tutorials Illustration" %}

Context

These tutorials guide developers through the steps of development, deployment in the cloud, and extension of a sample app in accordance with the SAP Business Technology Platform (BTP) Developers' Guide and following the SAP Cloud Application Programming Model (CAP). The tutorials are divided into groups and published to the SAP Tutorial Navigator.

Links

My role

More often than not, great documentation comes as a result of the collaboration of several people with different profiles. I worked on these tutorials as part of a small team consisting of myself, several developers, and an information architect. Here's how I contributed:

  • Pick up raw tutorial drafts from the developers.
  • Review and edit the tutorial from a language perspective.
  • Install and configure any required tools to prepare my development environment for testing.
  • Test the tutorial step by step.
  • Check code samples for correctness and compare with my testing project.
  • Add prerequisites, steps, notes, tips, screenshots, and more context as needed.
  • Note down any errors from the testing.
  • Search through internal and external community discussions to find solutions for the errors and adjust the tutorial.
  • Discuss tutorial scenario, structure, and any unsolved errors with the team.
  • Make changes as needed and test again.
  • Get a peer review.
  • Publish.

Tools

  • VS Code
  • MkDocs with Material for MkDocs
  • VitePress
  • Snagit
  • Git and GitHub
  • Bash