--- title: "A nine-point strategy for developing a successful API documentation portal" id: "16796" type: "post" slug: "a-nine-point-strategy-for-developing-a-successful-api-documentation-portal" published_at: "2023-05-02T12:30:12+00:00" modified_at: "2023-05-02T12:31:13+00:00" url: "https://www.cherryleaf.com/2023/05/a-nine-point-strategy-for-developing-a-successful-api-documentation-portal/" markdown_url: "https://www.cherryleaf.com/2023/05/a-nine-point-strategy-for-developing-a-successful-api-documentation-portal.md" excerpt: "Below is a strategy for developing a successful API documentation portal. By following these steps, you can create a plan for building a documentation portal that meets the needs of your API users, and supports the goals of your organisation...." taxonomy_category: - "API" - "Uncategorized" taxonomy_post_tag: - "api" - "plan" - "strategy" --- Below is a strategy for developing a successful API documentation portal. By following these steps, you can create a plan for building a documentation portal that meets the needs of your API users, and supports the goals of your organisation. ## Overview of the steps ## Step One: Determine your audience For example, you need to know: - Will it be developers, business users, or both groups, who will be using the portal? - What is their level of expertise? - What type of information do they need? - Do they use one programming language over another? Knowing who your audience will help you to design content that meet their needs. ## Step 2. Define your goals You and your organisation need to know, what is the purpose of the portal? What is it that you want to achieve? For example: - Is it to provide a comprehensive guide to your APIs, or just an overview? - Do you need to educate users on what can be achieved by using your APIs? - Are you trying to help developers integrate your APIs into their applications? Knowing this will help you identify the areas that will require attention. It will help you prioritise your efforts. And it will also help you plan the content and structure of your documentation. ## Step 3. Gather the requirements Talk to the stakeholders and understand their requirements. You’ll probably discover: - What different types of users you have - What they want to achieve - What tasks or jobs they want to get done - What features they need in the API and the portal - What types of documentation they expect - What tools or platforms should the portal support? - What terminology or processes you’ll need to explain ## Step 4. Choose a documentation toolset You need to have a tool that is a good fit to your requirements and goals. There’s software that can help you create and manage documentation for your APIs. For the reference content, there’s Swagger and Postman. For the onboarding and other content, there’s specialist applications like ReadMe, Redocly, and to an extent, GitHub and GitLab. There are also some good help authoring tools and content management tools. You also need to choose a format for your documentation. Do you want to provide static HTML documentation, or dynamic documentation that developers can interact with? Do you want content that can be generated automatically from your API code? Do you want to take a docs-as-code approach? ## Step 5. Plan the structure and the content By this we mean define the information model for your portal. This is about the navigation and organisation of the content. So think about the user journey. What are the steps that will take a developer to a successful outcome? This is where you identify the types of documentation you’ll need to provide. As a guide, here’s the documentation set that Google recommends its developers provide for what it calls “curious beginner users”: - A conceptual guide to build a deeper understanding of the underlying technology. - Cookbooks to explain how to accomplish a specific task. - API reference information to provide details on all the elements in an API. - A Getting Started guide to push a curious reader through the first few minutes of use. - Tutorials and Colabs to convert a reader from curious investigator to active user. - A one-pager that encapsulates the essence of a technology onto a single page. - And case studies that show how users successfully employed this technology in the real world. This stage involves planning the content for each section of the portal – deciding how you’ll divide the documentation into sections, and identifying the topics that need to be covered in each section. ## Step 6. Create the documentation Now it’s time to write and edit the content. Make sure all the content is clear, concise, and easy to understand. Some information might be in people’s heads, in experts’ heads. So that knowledge needs to be captured and written down. You could create a projects team dedicated to writing the content. If that resource is available. One approach is to have some of your API development team write the content. But they might not write it clearly. And they might not have the time to do it either. You could also bring in outside resource, such as Cherryleaf. We can work on some, or all, of the API documentation. When a Technical Writer create the content, it will be written clearly, and in a consistent manner. It will be well organised. And it will require less time from the Subject Matter Experts. ## Step 7. Test and refine You might need to improve any existing content that already exists. That content might be accurate and complete, but it might not be very usable. We recommend you test the documentation portal with users and gather feedback. Then use this feedback to refine and improve the documentation portal. You might also need to test the validity of the APIs themselves. ## Step 8. Publish the documentation At this point, you should be a live site that is findable, usable, and useful. ## Step 9. Maintain the documentation You’ll need to maintain the documentation, so it stays accurate. You could enable developers to provide feedback on the documentation and the APIs. This feedback will help you improve the documentation and the APIs. You might need to look at your analytics and carry out more usability testing from time to time. ## Summary Follow these steps, and you should have an API documentation portal that will be useful to your developers. Of course, Developer Relations is more than just the documentation. There’s promoting the API and supporting your community in other ways. But the documentation is a fundamental part. If you need help Cherryleaf provides API documentation writing services for API providers who want to: - Get more people using their APIs - Have fewer developers face problems when they make requests to the APIs Contact us for more information. ### Share this: - [Share on Facebook (Opens in new window) Facebook](https://www.cherryleaf.com/2023/05/a-nine-point-strategy-for-developing-a-successful-api-documentation-portal/?share=facebook) - [Share on LinkedIn (Opens in new window) LinkedIn](https://www.cherryleaf.com/2023/05/a-nine-point-strategy-for-developing-a-successful-api-documentation-portal/?share=linkedin) - [Share on WhatsApp (Opens in new window) WhatsApp](https://www.cherryleaf.com/2023/05/a-nine-point-strategy-for-developing-a-successful-api-documentation-portal/?share=jetpack-whatsapp) - [Share on Bluesky (Opens in new window) Bluesky](https://www.cherryleaf.com/2023/05/a-nine-point-strategy-for-developing-a-successful-api-documentation-portal/?share=bluesky) - ### *Related* ### Leave a Reply[Cancel reply](/2023/05/a-nine-point-strategy-for-developing-a-successful-api-documentation-portal/#respond) This site uses Akismet to reduce spam. [Learn how your comment data is processed.](https://akismet.com/privacy/) #### Previous post [Survey: Using AI and ChatGPT in technical communication](https://www.cherryleaf.com/2023/04/survey-using-ai-and-chatgpt-in-technical-communication/) #### Next post [Podcast 135: Writing procedures needed for regulatory compliance](https://www.cherryleaf.com/2023/05/podcast-135-writing-procedures-needed-for-regulatory-compliance/) #### Browse posts by month Browse posts by month Select Month October 2026 (1) September 2026 (12) August 2026 (8) July 2026 (7) June 2026 (14) May 2026 (8) April 2026 (6) March 2026 (14) February 2026 (9) January 2026 (9) December 2025 (7) November 2025 (9) October 2025 (10) September 2025 (7) August 2025 (6) July 2025 (1) June 2025 (3) May 2025 (2) April 2025 (5) March 2025 (3) February 2025 (3) January 2025 (2) November 2024 (8) October 2024 (3) September 2024 (2) August 2024 (3) July 2024 (4) June 2024 (1) May 2024 (2) April 2024 (4) March 2024 (1) February 2024 (2) January 2024 (1) December 2023 (2) November 2023 (9) October 2023 (8) September 2023 (5) August 2023 (3) July 2023 (1) June 2023 (1) May 2023 (2) April 2023 (3) March 2023 (2) January 2023 (2) December 2022 (4) November 2022 (1) October 2022 (1) September 2022 (1) August 2022 (1) July 2022 (1) June 2022 (1) May 2022 (2) April 2022 (1) March 2022 (1) February 2022 (1) January 2022 (2) December 2021 (1) November 2021 (2) October 2021 (1) August 2021 (1) July 2021 (2) June 2021 (3) May 2021 (5) April 2021 (3) March 2021 (3) February 2021 (1) January 2021 (2) December 2020 (4) November 2020 (4) August 2020 (3) February 2020 (3) January 2020 (1) November 2019 (3) October 2019 (1) September 2019 (1) August 2019 (3) July 2019 (2) June 2019 (3) May 2019 (4) April 2019 (1) November 2018 (2) October 2018 (1) July 2018 (2) June 2018 (4) May 2018 (2) April 2018 (3) March 2018 (4) February 2018 (2) January 2018 (3) December 2017 (2) October 2017 (3) September 2017 (1) August 2017 (3) July 2017 (2) June 2017 (7) May 2017 (4) April 2017 (5) March 2017 (1) February 2017 (7) January 2017 (1) December 2016 (3) November 2016 (4) October 2016 (1) September 2016 (5) July 2016 (1) June 2016 (3) May 2016 (1) April 2016 (2) February 2016 (2) January 2016 (5) December 2015 (1) November 2015 (4) October 2015 (2) August 2015 (1) July 2015 (1) June 2015 (2) May 2015 (3) February 2015 (2) January 2015 (6) December 2014 (1) October 2014 (1) September 2014 (4) June 2014 (4) May 2014 (1) April 2014 (2) March 2014 (3) February 2014 (4) January 2014 (4) November 2013 (2) October 2013 (5) September 2013 (3) July 2013 (3) June 2013 (11) May 2013 (4) April 2013 (6) March 2013 (7) February 2013 (4) January 2013 (4) December 2012 (9) November 2012 (23) October 2012 (14) September 2012 (8) August 2012 (4) July 2012 (12) June 2012 (12) May 2012 (10) April 2012 (8) March 2012 (12) February 2012 (3) January 2012 (6) December 2011 (2) October 2011 (3) August 2011 (1) June 2011 (5) May 2011 (2) April 2011 (1) January 2011 (1) December 2010 (1) November 2010 (3) October 2010 (4) September 2010 (8) August 2010 (5) May 2010 (2) April 2010 (3) March 2010 (3) February 2010 (2) January 2010 (3) December 2009 (2) November 2009 (6) September 2009 (1) July 2009 (6) June 2009 (7) April 2009 (8) March 2009 (3) February 2009 (3) January 2009 (3) December 2008 (1) November 2008 (3) October 2008 (3) September 2008 (4) August 2008 (1) July 2008 (3) June 2008 (5) May 2008 (2) April 2008 (2) March 2008 (3) February 2008 (2) January 2008 (1) November 2007 (3) October 2007 (2) September 2007 (1) July 2007 (3) November 2006 (1) October 2006 (2) September 2006 (3) August 2006 (1) April 2006 (1) March 2006 (3) #### Browse posts by category