Create, test, and build online docs with a new IntelliJ Platform plugin
Product docs, API references, tutorials, developer guides, and how-tos - all inside your favorite JetBrains IDE.
Write in Markdown or combine it with our semantic markup. Convert Markdown fragments sent in by external contributors on the fly.
Not just broken links. Spot missing resources, incorrect attribute values, non-unique IDs. Automate spelling and style guide checks.
The preview shows the docs exactly as your readers will see them. You don’t need to run a build and wait until it finishes to check if your updates look good.
Reuse anything, from smaller content chunks to entire topics or even sections of your TOC. Stay flexible with filters and variables. Use predefined templates for complex markup elements or configure your own.
With out-of-the box Git integration, a builder that transforms your sources into a documentation website, a library of carefully designed frontend components, and automated tests that run on any CI/CD tool, you can focus on what matters most – your content.
With JetBrains IDEs you can keep your code error-free. We do the same for 25+ natural languages, including English, German, Spanish, Russian, and Chinese. All have an ML-based spellchecker and a grammar error correction tool.
This project developed out of hundreds of customer interviews and 10+ years of working on the IntelliJ Platform documentation. These experiences gave us a long list of features to build and problems to solve. We are here to address them one by one.
Do you want to help?
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, but the team
Single-source publishing is a powerful must-have feature that is normally among the top three competitive advantages for any professional help authoring solution. In this post we would like to draw your attention to its pitfalls so that you are forewarned and can reuse content wisely.
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.
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.
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 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.
We are enthusiastic about docs and we want to create the best tool for people who write them – ideally with your help. Let's connect!
Contact us at email@example.com, anytime.
Get updates on JetBrains tools for authoring and publishing technical documentation and enroll for the Early Access Program.