From c61f064a0ec9e119fe36ad5cb21667b8a6a7710e Mon Sep 17 00:00:00 2001 From: JR Date: Tue, 23 Jan 2024 13:25:46 +0100 Subject: [PATCH] add: Article about Developer portal --- practices/Developer_portal.md | 71 +++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 practices/Developer_portal.md diff --git a/practices/Developer_portal.md b/practices/Developer_portal.md new file mode 100644 index 00000000..35769d4f --- /dev/null +++ b/practices/Developer_portal.md @@ -0,0 +1,71 @@ +--- +slug: developer-portal +stages: + - development +short_description: A Developer Portal is a centralized online platform that equips developers with tools, documentation, and resources to efficiently use and integrate APIs or SDKs provided by a company, fostering collaboration and a seamless developer experience. +tags: + - Developer portal + - Developers + - API management + - API development + - Web development + - Developer expirience + - Developer tools +keywords: + - developer portal + - api management + - sdk + - oas + - documentation + - code samples +author_github_username: jan.ricica +--- + + +# Developer Portal + +## What is a Developer Portal? + +When it comes to service adoption and integration, the Developer Portal is where a developer can go for all the resources they could possibly need. Users, mostly developers, can find information about the company's [**API**](https://developerexperience.io/articles/rest-api) (**A**pplication **P**rogramming **I**nterface) services, **[SDK](https://developerexperience.io/articles/software-development-kit)s (S**oftware **D**evelopment **K**its), and other service integration options. View the developer portal as a one-stop shop for guides, technical documentation and code examples, with a developer focus. + +## Why might you want a Developer portal? + +Now that you understand what a developer portal is, you may be asking why you should care about making one. It is crucial to realize that a developer portal is exclusive to businesses that provide developer tooling. There is little to no reason to consider a developer portal unless you have a publicly accessible API or another suitable method of integrating your services programmatically. + +If you offer developer-centric services, consider maintaining a developer portal, without a doubt. Most of the time, developers are more interested in technical data and straightforward information than attractive marketing. And that's exactly what the Developer Portal offers. + +In addition, the developer community is of very large scale. If you become known as "the one with a great dev portal" within this group, it will help you acquire new customers. In other words, a word-of-mouth marketing strategy is one of the most powerful in the realms of software development. + +## Problems the Developer Portal Helps to Solve? + +The developer portal provides solutions to numerous issues and situations. Some benefits of setting up a dev portal are as follows: +- Embrace a **new customer** segment by opening up your products to them. +- Use your tools to **drive communication** and relieve pressure on support. +- Find out how people are really **using your product** by analyzing their behavior. +- Keep the **community updated** on newly released and upcoming products. +- **Gather feedback** from users by inviting them to try beta versions of your product. + +## How to create a Developer portal? + +Where to begin is a bit of a challenge because this is a wide-ranging subject. Naturally, consulting a business like DX Heroes, which specializes in creating bespoke developer portals, is your best bet. + +If this is not an option for you, here are some of the steps you should consider: +- **Understand** what you have to offer to the **community**. +- **Make a strategy** for the features you intend to make available to developers. +- **Create a blueprint** for your portal and arrange its components in a sensible hierarchy. +- Make sure the entire developer portal follows the same **language structure and style**. +- **Take inspiration** from the successful implementation of completed portals. +- Keep all available information **up-to-date**. +- **Automate** everything that's possible to be automated. + +## Common Pitfalls of the Developer Portals + +Keep in mind that the Developer Portal might present you with a few important challenges: +- The most serious concern is that the information provided in the **developer portal will not be up-to-date**. Keep an eye out for this at all times. +- **Lower developer interest** than expected can result in loss of interest and a failure to keep information updated and promoted. +- **Poor onboarding** is an issue that affects many companies. Before potential customers can begin using your service, you must ensure that they have clear and accurate instructions on how to do it. +- **Ignoring developer's feedback** causes a greater number of users to depart than join. Additionally, developers tend to be helpful and can have a clear understanding of what they need. + +## Great developer portals + +Developer portals such as [Stripe](https://stripe.com/docs) and [Discord](https://discord.com/developers/docs/intro) are excellent examples. Feel free to explore it in search of ideas. \ No newline at end of file