The JetBrains Blog

Blog

Skip to content
  • Blogs by Topic
  • Search
  • Language
    • English
    • Français
    • 한국어
    • 简体中文
Burger menu icon
  • IDEs

    • AppCode
    • CLion
    • DataGrip
    • DataSpell
    • Fleet
    • GoLand
    • IntelliJ IDEA
    • PhpStorm
    • PyCharm
    • RustRover
    • Rider
    • RubyMine
    • WebStorm
  • Plugins & Services

    • Big Data Tools
    • Code With Me
    • Quality Assurance
    • JetBrains Platform
    • Scala
    • Toolbox App
    • Writerside
  • Team Tools

    • Datalore
    • Space
    • TeamCity
    • Upsource
    • YouTrack
    • Hub
    • Qodana
  • .NET & Visual Studio

    • .NET Tools
    • ReSharper C++
  • Languages & Frameworks

    • Kotlin
    • Ktor
    • MPS
  • Education & Research

    • JetBrains Academy
    • Research
  • Company

    • Company Blog
    • Security
Writerside logo

On Writer's Side

Intelligent tools for writers and new ways to write better

Follow
  • Follow:
  • Twitter Twitter
Solutions
  • All
  • News
  • Tech Writing
  • Tools
The Kotlin Mascot greets the Writerside character

Harnessing the Power of the Kotlin DSL for Documentation

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…

Svetlana Novikova Svetlana Novikova

Field Notes: The Writerside Team at Write the Docs Portland and soap! Krakow

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…

Sasha Maximova Sasha Maximova
Tech Writer's Git Story

Tech Writer’s Git Story: From Isolation To Collaboration

When I joined JetBrains back in 2014 as a senior technical writer, our team consisted of 5 documentarians covering 6 products.  We sat together in a separate room and kept our door closed most of the time, rarely mingling with any developers. We’d see them at the daily IntelliJ IDEA standup,…

Anna Gasparyan Anna Gasparyan

NORDIC TechKomm Stockholm 2023 Field Notes

It was hard to choose which tech writing conference to go to this year. Our team decided to spend the 2023 budget on these 7 conferences. The first one is over! Let us share our experience – biased maybe, but hopefully useful to those who plan to attend next year. Audience: There's a whole world …

Svetlana Novikova Svetlana Novikova

Meet the Writerside Team at Events in 2023

To stay ahead of the curve, the Writerside team attends various events to discuss new trends, technologies, and best practices for authoring and publishing technical content. Come meet us, get a quick demo of our product, and discuss the latest developments in writing and publishing docs-as-code.

Svetlana Novikova Svetlana Novikova

Publish Documentation for Your Plugin – With Writerside

The more we work on a tool, the more intuitive and easy to use it seems. This is why documentation is sometimes postponed to the last minute, or even scrapped completely. Customers are left to figure out for themselves what the tool can do. However, documentation benefits even a small team, espec…

Sasha Maximova Sasha Maximova

Content reuse – a productivity booster or a vicious circle?

Single-source publishing is a powerful must-have feature that is normally among the top three competitive advantages for any professional help authoring solution – and for good reason. Single-sourcing reusable content lets you: Maintain consistency throughout your documentation in terms of style,…

Anna Gasparyan Anna Gasparyan

Spell Checker for Code in IntelliJ IDEA

One day you write some code, commit, push, and then receive a comment on the pull request: “Looks good. Oh, but you misspelled this word in a class name". Now you have to change the pull request just because of the typo. Annoying and time-consuming, isn't it? How IntelliJ IDEA spellchecks code …

Svetlana Novikova Svetlana Novikova

Writing With Style: 10 Style Guides to Inspire You

A writing style guide is a set of rules and agreements for everyone involved in writing or editing documentation in a company. Usually, a style guide prescribes using certain words, expressions, terms, and punctuation. It can sometimes go even beyond that and cover content architecture or UI texts. …

Svetlana Novikova Svetlana Novikova

The Holy Grail of “Always-Up-to-Date” Documentation

When you ask someone what’s wrong with your documentation, the top 3 answers will be: no one reads it, it is misleading, and it is outdated. In this post, we will discuss how to keep your documentation up to date. Hey, doc! Why so outdated? Documentation is not source code. For code, you can w…

Svetlana Novikova Svetlana Novikova

Subscribe to Blog updates

By submitting this form, I agree that JetBrains s.r.o. ("JetBrains") may use my name, email address, and location data to send me newsletters, including commercial communications, and to process my personal data for this purpose. I agree that JetBrains may process said data using third-party services for this purpose in accordance with the JetBrains Privacy Policy. I understand that I can revoke this consent at any time in my profile. In addition, an unsubscribe link is included in each email.

Thanks, we've got you!

  • Privacy & Security
  • Terms of Use
  • Legal
  • Genuine tools
Language
  • English
  • Français
  • 한국어
  • 简体中文
  • Twitter
  • Facebook
  • Linkedin
  • Instagram
  • Youtube
  • RSS
  • Tiktok
Copyright © 2000 JetBrains s.r.o.