We are JetBrains partners

Starting with the September 2024 release, the JetBrains Writerside IDE will now include The Good Docs Project templates out-of-the-box, right alongside the default JetBrains templates. This means you can use Writerside to easily load one of The Good Docs Project templates and start writing great documentation immediately.

For those unfamiliar with Writerside, JetBrains launched Writerside in 2023 as part of a strategic effort to improve tools at every stage of the software development process, including writing documentation, testing, and code analysis. Writerside provides a writing environment with all the features of a modern editor: live previews, syntax highlighting, intention actions, filters, reusable snippets, and more. These features enable developers and writers to create high-quality technical documentation using a docs-as-code, DevOps-friendly workflow.

Best of all, the Writerside IDE is free to try and use, making it accessible to everyone looking to streamline their technical documentation process. From the official Writerside product page:

If you’d like to try out our templates in a simple, elegant code editing environment, consider downloading Writerside today.

Since JetBrains first approached us about the Writerside project a few months ago, we’ve already seen significant benefits from our collaboration. Through close work with the JetBrains developers, we realized our templates needed further standardization to enhance usability and make them easier to consume downstream.

In response, our Tech Team recently launched a major template standardization initiative:

Looking ahead, we’re laying the groundwork for future improvements that will make our templates even more compatible with Writerside. We’re excited about our ongoing collaboration with JetBrains, which will help make our templates even more user-friendly and effective.

When asked to comment on our partnership, Hadi Hariri from JetBrains said:

One of the key reasons we’re excited about partnering with JetBrains is because of their deep commitment to open source. JetBrains not only creates and contributes to numerous open source projects, but they also provide their tools free of charge to open source developers.

What we value most is how JetBrains actively encourages and supports their employees in making meaningful contributions to open source projects. In fact, this is how our relationship with JetBrains first began. JetBrains employees Svetlana Novikova and Alina Terekhova are long-time contributors to our project. Svetlana also serves as a member of our project steering committee and as a lead for our UX and Outreach working group. We deeply appreciate companies like JetBrains that foster a culture of open source contribution. Their support, combined with the talent and camaraderie of their team, has made a lasting impact on our project.

We’re thrilled with how Writerside has simplified and streamlined the process of using The Good Docs Project templates. Now, anyone can quickly access and use our templates directly within a code editor, right out of the box.

Before Writerside, the only way to use our templates was to manually copy and paste files or fork them into a new repository---an approach that was neither easy nor scalable. But with Writerside, users can now start working with our templates in a sophisticated code editing environment in just a few clicks.

Because it will be so much easier to use our templates, we believe this will extend our project’s reach by making our templates accessible to a broader audience. As more people adopt them, we’ll benefit from valuable user feedback that will allow us to continuously improve and refine our templates.

With ongoing input from the Writerside user and developer community, we’re confident our templates will evolve to become the standard for writing a wide range of documentation content.

We are happy to join with JetBrains to provide developers and writers with the tools they need to create outstanding documentation. We’re eager to help Writerside users overcome writer’s block and start producing high-quality, user-friendly documentation using our expertly crafted templates and guides.

Download Writerside today and share your feedback with us!