When writing documentation for programming tutorials, showcasing multiple code samples in various languages can become overwhelming. Instead of overwhelming readers with long blocks of code, providing an organized and user-friendly experience is essential. A tabbed interface is one of the most effective ways to achieve this. A tabbed interface allows you to display code samples … Continue reading Add Tabs for Multiple Programming Languages on Doc Sites
Tag: technical writing
Mastering Branching Strategies for Documentation in Docs as Code
Branching strategies are essential in Docs as Code for enabling smooth collaboration, parallel updates, and efficient content management. While developers have long used branching to separate features, fixes, and releases, documentation teams can benefit from similar techniques to improve version control, handle urgent updates, and align content with product releases. Below, we explore three advanced … Continue reading Mastering Branching Strategies for Documentation in Docs as Code
Build a Product Documentation Roadmap
Creating a product documentation roadmap is a strategic approach to ensure that product documentation aligns with project goals, meets user needs, and is delivered on time. A roadmap outlines documentation milestones, assigns responsibilities, and highlights critical resources, providing a clear direction for technical writers, developers, and other stakeholders. Here’s a step-by-step guide to creating an … Continue reading Build a Product Documentation Roadmap
How CTOs Can Leverage Technical Writing to Drive Success
For many tech companies, technical writing is often viewed as a support function—useful for creating documentation, but not necessarily as a core strategic asset. However, for CTOs, technical writing can be a critical tool for scaling efficiently, enhancing customer satisfaction, and driving cross-functional alignment. Here’s a closer look at how CTOs can leverage technical writing … Continue reading How CTOs Can Leverage Technical Writing to Drive Success
Fostering a Culture of Continuous Learning on your Technical Writing Team
The need for continuous learning is not just a luxury in the tech world, it’s essential for survival. As a technical writer, you are responsible for understanding complex technologies and conveying that knowledge to your audience in a clear and effective way. But to do that well, you and your team need to stay ahead … Continue reading Fostering a Culture of Continuous Learning on your Technical Writing Team
Tips for Being a Developer Advocate as a Technical Writer
The role of a developer advocate is becoming increasingly vital in the rapidly evolving tech landscape. As a technical writer stepping into this dynamic position, you have a unique opportunity to bridge the gap between developers and the products they use. Here are some essential tips to thrive as a developer advocate while leveraging your … Continue reading Tips for Being a Developer Advocate as a Technical Writer
Embracing Agile in the Documentation Lifecycle
In today’s fast-paced software development environment, effective documentation is more crucial than ever. Traditional approaches often result in excessive documentation that quickly becomes outdated or irrelevant. This is where Agile documentation comes into play, transforming the documentation lifecycle into a more dynamic, user-focused process. Understanding Agile Documentation Agile documentation integrates seamlessly with the Agile development … Continue reading Embracing Agile in the Documentation Lifecycle
How to Measure an Exceptional Software Technical Writer
How do you measure the impact and skill of an exceptional software technical writer? In this blog post, I explore the key metrics and qualities that separate average writers from outstanding ones. Technical documentation is a crucial component of user satisfaction, product usability, and operational efficiency. Yet, recognizing the impact of a great writer requires … Continue reading How to Measure an Exceptional Software Technical Writer
Why Business Acumen is Essential for Software Technical Writers
When we think of software technical writers, the first thing that comes to mind is usually their technical expertise and ability to make complex information accessible. However, one crucial aspect often overlooked is the importance of business acumen. Understanding business concepts can significantly enhance a writer’s ability to produce impactful documentation. This blog post explains … Continue reading Why Business Acumen is Essential for Software Technical Writers
The Software Documentation Lifecycle from Start to Finish
Documentation is crucial to any software project, guiding users, developers, and stakeholders in understanding how to use, maintain, and improve the product. However, for documentation to stay helpful, it needs to evolve with the software itself. Enter the Software Documentation Lifecycle, a framework that helps ensure your documentation stays accurate, useful, and up-to-date at each … Continue reading The Software Documentation Lifecycle from Start to Finish
Double Yew! 