Why Docs as Code Should Be Part of Your Dev Cycle: A Look at the Cloud Industry and the Importance of Documentation

Why Docs as Code Should Be Part of Your Dev Cycle: A Look at the Cloud Industry and the Importance of Documentation

Introduction:

In the rapidly evolving cloud industry, it's essential to keep an eye on the latest updates and trends. One of the key factors driving growth in the industry is the integration of AI into cloud services. Azure, in particular, has seen significant growth attributed to AI, with a 6% increase in revenue from the previous quarter. This growth is largely driven by the usage of Azure OpenAI API. On the other hand, AWS, while remaining the industry leader, has experienced slower growth due to its focus on providing low-cost compute and storage services, with less emphasis on AI and managed services.

The Role of AI in Cloud Growth:

Azure's success in the cloud industry can be largely attributed to its focus on AI. AI is rapidly becoming the most important avenue of growth for software companies, and Azure has capitalized on this trend effectively. Without AI, Azure would still be growing at an impressive 24% YoY. This highlights the significance of AI in driving revenue growth in the cloud industry. Azure's approach to AI is based on the "Copilot Stack," offering customers a range of options from buying pre-built applications to building their own apps using Azure OpenAI. Additionally, Microsoft's partnership with Nvidia for data center GPUs allows customers to train their own AI models.

AWS's Focus on Compute and Storage:

While AWS continues to lead in compute and storage costs, its growth has been slower compared to Azure and GCP. AWS has focused on delivering compute and storage services at the lowest cost possible, resulting in a profitable business. However, its reliance on software companies born in the cloud has limited its revenue growth. Many of these software companies are SaaS businesses that have not re-accelerated growth rates after a slowdown in 2022. Nevertheless, AWS's strategy of offering a full-stack approach through services like Amazon Q shows promise, although results are yet to be seen.

GCP's Re-Acceleration and Strategy:

GCP had a strong quarter, showing re-acceleration back towards its historical trendline. GCP's strategy focuses on infrastructure, data & AI, security, and collaboration. Its AI strategy aligns with that of AWS and Azure, emphasizing infrastructure, platform, and application. However, there seems to be a disconnect between Google leadership and GCP leadership, which may impact the execution of GCP's strategy.

The Importance of Documentation in Development:

Moving beyond the cloud industry, documentation plays a crucial role in software development. The traditional approach of treating documentation as a separate process from development can be unnecessarily complicated. Documentation is often the face of a product, especially when it comes to API references. Therefore, incorporating documentation into the development cycle is essential.

The Docs as Code Approach:

The Docs as Code approach treats documentation as code, using the same tools and processes as software development. This approach brings several benefits, including easier management and publication of documentation. Storing documentation in a plain-text format, such as markdown, ensures accessibility without the need for special equipment or software. Syntax review can be automated using linters and grammar checkers, enhancing the quality of the documentation.

Decoupled Frontend and Backend:

The Docs as Code approach frees technical content creators from worrying about page design and styling. Instead, they can focus on the content itself. Different types of content require specific sections, such as a Prerequisites section or an Introduction section. Clear and logical section titles improve the findability of content within a documentation site. Additionally, optimizing the search function enhances the overall user experience.

Version Control and Collaboration:

Embracing the practice of storing documentation in a version control system (VCS) brings consistency and collaboration to the documentation process. Using a git-based product or similar VCS allows technical writers to branch, merge, and track changes to documentation. This ensures that documentation evolves alongside the software, maintaining relevance and accuracy.

Automated Testing and Deployment:

The Docs as Code approach leverages automated testing and deployment tools. By using a static site generator or similar tools, documentation can be easily published from the source files. This streamlines the publication process and ensures consistency.

Actionable Advice:

1. Incorporate AI into your cloud strategy: As demonstrated by Azure's success, AI is a significant driver of growth in the cloud industry. Consider how AI can be integrated into your services to tap into this potential revenue stream.

2. Adopt the Docs as Code approach: By treating documentation as code and using the same tools and processes, you can streamline the management and publication of documentation. This approach promotes collaboration, version control, and consistency.

3. Prioritize user experience in documentation: Optimize the organization, navigation, and findability of your documentation to enhance the user experience. Ensure that content is easily accessible and searchable, improving user satisfaction and reducing support requests.

Conclusion:

The cloud industry continues to evolve rapidly, with AI playing a crucial role in driving growth. Azure has capitalized on AI effectively, while AWS focuses on delivering low-cost compute and storage services. GCP has shown re-acceleration towards its historical trendline. In addition to cloud industry insights, incorporating the Docs as Code approach in your development cycle can greatly benefit your documentation process. Treating documentation as code, adopting version control, and leveraging automated testing and deployment tools can enhance collaboration, consistency, and user experience. By implementing these strategies, you can stay ahead in the cloud industry and ensure that your documentation reflects the quality of your products or services.