Swift Roundup #3: How Setup & Onboarding Docs Can Impact Your DevEx (For Better or Worse!)

This weekly presents two things that can enhance your developer experience (DevEx): the developer portal and automations in your onboarding and setup documentation, including project READMEs. Enjoy your reading! 😎

Author

Shaked Braimok Yosef
June 22, 2023

Platform Engineering course - is coming soon 🏫

A new digital course by Senora.dev focused on Platform Engineering is coming soon. In this course, you'll learn how to implement and manage internal developer platforms as both a Platform Engineer and a Software Engineer. The course covers topics such as CI/CD, AWS, Containers, and includes numerous hands-on labs 🧪. Stay tuned for more updates!

MUST-READ ⬇️

Why do you need a developers portal in your organization?

In short Organizations today build products from small units—micro-services/APIs. The more micro-services and APIs there are, the more difficult it is to navigate and follow them. One of the main reasons for the portal is to document all the organization's APIs with important details about them (status, mock request, CI/CD, costs, etc.), so the tool can be used by developers to know all the services in the organization. It can also save valuable time by providing a general view of the state of t

www.senora.dev/post/why-do-you-need-a-developer-portal-in-your-organization

Senora Recommends 👏

Every week, Senora recommends an open-source tool that will help you with Self-Service & DevEx. This week, we would like to highlight the following project:

GitHub - stateful/runme: Execute commands inside your runbooks, docs, and READMEs.

Execute commands inside your runbooks, docs, and READMEs. - GitHub - stateful/runme: Execute commands inside your runbooks, docs, and READMEs.

github.com/stateful/runme

Installation documents can indeed become tedious and overwhelming for developers, especially when they contain excessive information that may not be immediately relevant or useful. However, incorporating automation within the README can greatly enhance the installation or onboarding process. Automation not only speeds up the process but also adds an element of fun and convenience for developers.

Whenever you're ready, there are three ways Senora can help you:

  1. Learn DevOps and Cloud Infrastructures as a Software Engineer/Platform Engineer in the Platform Engineering era.

  2. Get Senora's premium consulting services for Cloud architecture design, infrastructure code, Internal Developers Platform (IDP), workflows, and more.

  3. Promote yourself to Senora's subscribers by sponsoring this newsletter. (Contact Us)