Evolution of TC

Streamlining Success: A Case Study on Mastering Cross-Product Documentation

  • Presentation
  • ContentOps, DocOps, Content as a Service
  • 04. June
  • 13:00 - 13:40 PM (CEST)
  • E.11 Training Room
  • finished
  •  Ekaterina Mitova

    Ekaterina Mitova

    • SAP Labs Bulgaria
  •  Svetoslav Pandeliev

    Svetoslav Pandeliev

    • SAP Labs Bulgaria

Contents

Assess the efforts to create and enhance cross-product documentation, specifically the SAP BTP Developer's Guide, its impact on the SAP application development, and identify ways to continuously improve the content.

We would like to share our approach for handling cross-product documentation, which includes:

  • Ensure the structure of the SAP BTP Developer's Guide benefits developers across multiple products.
  • Integrate with GitHub.
  • Create end-to-end tutorials aligned with the guide's content.
  • Evaluate the effectiveness of the tutorials.
  • Assess the impact of SAP Discovery Center's mission.

Takeaways

Efforts to create and enhance cross-product document including detailed structuring, GitHub integration for feedback, creating end-to-end tutorials, and assessing user engagement.

Prior knowledge

This case study is applicable to technical writers who are at the beginning of their career and for experienced information architects.

Speakers

 Ekaterina Mitova

Ekaterina Mitova

  • SAP Labs Bulgaria
Biography

I started as an information developer. Then, a couple of years later, I switched to development, only to realize that information development is my true passion. Or in other words, I love to provide help that really helps. And I’ve always loved working on innovative projects that bring value.

 Svetoslav Pandeliev

Svetoslav Pandeliev

  • SAP Labs Bulgaria
Biography

Sveto joined the tech communication world in 2018 after spending several years in pre-sales and patent application drafting. He's especially interested in everything related to docs-as-code because it removes one of the major hurdles in every tech writer's job - getting those technical details from the subject matter experts. His on-the-job interests are mainly around developer documentation such as tutorials and API docs and creating videos. 
 

Ever since he switched careers, Sveto's been telling everyone that he would've become a tech writer earlier had he known about the profession when graduating. Since October 2022, Sveto's been part of the initiative committee of tekom Bulgaria, helping grow the technical writing community in the country and spread the word about technical writing among the younger generation.