On Writer's Side

In October 2023, we launched the Early Access Program for Writerside – a tool for authoring, testing, and publishing documentation. Built on the IntelliJ Platform, Writerside was available in two versions: a standalone tool and a plugin for JetBrains IDEs. Our goal was to serve two key audiences – d…

Reusing content is one of the few things that software developers and technical writers are equally passionate about. Both know that avoiding duplication isn’t just a good practice, it’s essential – and it works for documentation, just as it does for code: Decreased redundancy: Reusing content e…

Each Early Access release is designed to make writing documentation easier and more enjoyable. This update is based on your feedback and focuses on improving code blocks, but there is more! Thank you all for sharing your ideas. It’s a pleasure to keep improving our product for you. Code samples…

“I hate to write, but I love having written,” a famous saying goes. Don’t we all – especially those of us who write functional texts, like technical documentation? We often have too little time to even convey the basic idea, let alone categorize and structure the information – whether it’s a how-to …

In today’s world, data platforms are crucial for any organization. These platforms make data storage assets available and provide the necessary tools to work with data effectively. In this blog post, we’ll explore the inner workings of JetBrains' data kitchen and the role that documentation plays in…

In today's fast-paced development environment, effective API documentation is not just a nice-to-have, but a necessity. This blog post explores how understanding pattern recognition and learning styles can revolutionize the way we create API documentation. By examining the different types of knowledge present in API references and recognizing diverse developer learning strategies, we can create documentation that is not only informative but also engaging and intuitive.

The first Writerside build with AI-powered features is now available as part of its Early Access Program. Read on the full story, or jump straight to the new features. No longer a threat, AI is a writer's friend Just one year ago, tech writers felt threatened by the AI breakthrough and we…

5 customer stories, 6 “aha moments”, and so many things to fix. ? According to the Developer Ecosystem Survey, 10–12% of software developers also write docs. Most developers dislike writing docs, viewing them as a necessary but tedious part of maintaining complex products. At Writerside, we see d…

The winter holidays have historically been a time for magic and stories. With this in mind, I'd like to share a little story of my own - one with more than just a sprinkling of magic. Have you ever wondered where the name of our product came from? I’ve been asked this question many times on diffe…

Our first blog post on Git sparked discussions among different communities of tech writers. Many questioned the described workflow and highlighted that having to collaborate on the same file, pull and rebase changes daily, and resolve conflicts may be a sign of organizational and content management …

DSL? What DSL?The essence of the Kotlin DSLDemonstrationThree key strengths of our approachSeparation of ConcernsDocs-as-Code on a whole new levelExtensibilityWhy Kotlin?Do I need to be a coder to use the Kotlin DSL?Conclusion This material was initially presented at the API The Docs Conference i…

Write the Docs Portland Not that I can judge, as I'm not a frequent conference-goer, but Write the Docs (WTD) stands out from all others I have attended – the good, the bad, and the corporate.  A friendly and open community was eager to accept anybody who writes docs, whatever their o…